21 |
22 |
23 |
24 |
25 |
32 |
Lua mode
29 |
70 |
76 |
77 | Loosely based on Franciszek
78 | Wawrzak's CodeMirror
79 | 1 mode. One configuration parameter is
80 | supported, specials, to which you can provide an
81 | array of strings to have those identifiers highlighted with
82 | the lua-special style.
83 | MIME types defined: text/x-lua.
84 |
85 |
86 |
--------------------------------------------------------------------------------
/servers/twitch_fragments/setup.lua:
--------------------------------------------------------------------------------
1 | twitch_display_lines = {}
2 | gui = gui or GuiCreate()
3 | xpos = xpos or 80
4 | ypos = ypos or 30
5 | randomOnNoVotes = false
6 | math.randomseed(os.time())
7 |
8 | function draw_twitch_display()
9 | GuiStartFrame( gui )
10 | GuiLayoutBeginVertical( gui, xpos, ypos )
11 | for idx, line in ipairs(twitch_display_lines) do
12 | GuiText(gui, 0, 0, line)
13 | end
14 | GuiLayoutEnd( gui )
15 | end
16 |
17 | function set_countdown(timeleft)
18 | twitch_display_lines = {"Next vote: " .. timeleft .. "s"}
19 | end
20 |
21 | outcomes = {}
22 | function clear_outcomes()
23 | outcomes = {}
24 | end
25 |
26 | function clear_display()
27 | twitch_display_lines = {}
28 | end
29 |
30 | function add_outcome(outcome)
31 | table.insert(outcomes, outcome)
32 | end
33 |
34 | outcome_generators = {}
35 |
36 | function draw_outcomes(n)
37 | local candidates = {}
38 | for idx, generator in ipairs(outcome_generators) do
39 | candidates[idx] = {math.random(), generator}
40 | end
41 | table.sort(candidates, function(a, b) return a[1] < b[1] end)
42 | clear_outcomes()
43 | for idx = 1, n do
44 | add_outcome(candidates[idx][2]())
45 | end
46 | end
47 |
48 | function update_outcome_display(vote_time_left)
49 | twitch_display_lines = {"Voting ends: " .. vote_time_left}
50 | for idx, outcome in ipairs(outcomes) do
51 | table.insert(
52 | twitch_display_lines,
53 | ("%d> %s (%d)"):format(idx, outcome.name, outcome.votes)
54 | )
55 | end
56 | end
57 |
58 | function set_votes(outcome_votes)
59 | for idx, outcome in ipairs(outcomes) do
60 | outcome.votes = outcome_votes[idx] or 0
61 | end
62 | end
63 |
64 | function do_winner()
65 | local best_outcome = outcomes[1]
66 | for idx, outcome in ipairs(outcomes) do
67 | if outcome.votes > best_outcome.votes then
68 | best_outcome = outcome
69 | end
70 | end
71 | if best_outcome.votes > 0 then
72 | GamePrintImportant(best_outcome.name, best_outcome.desc or "you voted for this")
73 | best_outcome:func()
74 | elseif randomOnNoVotes then
75 | local random_outcome = outcomes[math.random(1, 4)]
76 | GamePrintImportant("Nobody voted!", "Random option choosen: " .. random_outcome.name)
77 | random_outcome:func()
78 | else
79 | GamePrintImportant("Nobody voted!", "Remember to vote!")
80 | end
81 | clear_outcomes()
82 | clear_display()
83 | end
84 |
85 | add_persistent_func("twitch_gui", draw_twitch_display)
--------------------------------------------------------------------------------
/mod_ws_api/data/ws/pollws.lua:
--------------------------------------------------------------------------------
1 | if pollws then return end
2 |
3 | print("Attempting to link pollws.dll through FFI")
4 | local ffi = ffi or _G.ffi or require("ffi")
5 | ffi.cdef[[
6 | struct pollsocket* pollws_open(const char* url);
7 | void pollws_close(struct pollsocket* ctx);
8 | int pollws_status(struct pollsocket* ctx);
9 | void pollws_send(struct pollsocket* ctx, const char* msg);
10 | int pollws_poll(struct pollsocket* ctx);
11 | unsigned int pollws_get(struct pollsocket* ctx, char* dest, unsigned int dest_size);
12 | unsigned int pollws_pop(struct pollsocket* ctx, char* dest, unsigned int dest_size);
13 | ]]
14 | print("CDEF was OK")
15 | pollws = ffi.load("pollws")
16 | print("FFI was OK")
17 |
18 | local POLLWS_STATUS_CODES = {
19 | [-1] = "invalid",
20 | [ 0] = "closed",
21 | [ 1] = "opening",
22 | [ 2] = "open",
23 | [ 3] = "error"
24 | }
25 |
26 | function open_socket(url, scratch_size)
27 | -- might as well have a comfortable megabyte of space
28 | if not scratch_size then scratch_size = 1000000 end
29 | local res = {
30 | _socket = pollws.pollws_open(url),
31 | _scratch = ffi.new("int8_t[?]", scratch_size),
32 | _scratch_size = scratch_size
33 | }
34 | function res:set_scratch_size(scratch_size)
35 | self._scratch = ffi.new("int8_t[?]", scratch_size)
36 | self._scratch_size = scratch_size
37 | end
38 | function res:poll()
39 | if not self._socket then return end
40 | local msg_size = pollws.pollws_pop(self._socket, self._scratch, self._scratch_size)
41 | if msg_size > 0 then
42 | local smsg = ffi.string(self._scratch, msg_size)
43 | return smsg
44 | else
45 | return nil
46 | end
47 | end
48 | function res:send(msg)
49 | if not self._socket then return end
50 | pollws.pollws_send(self._socket, msg)
51 | end
52 | function res:close()
53 | pollws.pollws_close(self._socket)
54 | self._socket = nil
55 | end
56 | function res:raw_status()
57 | if not self._socket then return -1 end
58 | return pollws.pollws_status(self._socket)
59 | end
60 | function res:status()
61 | return POLLWS_STATUS_CODES[self:raw_status()] or "unknown"
62 | end
63 | function res:run_async(on_message)
64 | self.running = true
65 | async(function()
66 | while self._socket and self.running do
67 | local msg = self:poll()
68 | if msg then on_message(self, msg) end
69 | wait(1)
70 | end
71 | end)
72 | end
73 | function res:stop()
74 | self.running = false
75 | end
76 |
77 | return res
78 | end
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | # noita-ws-api
4 | Websocket based API to Noita: allows Noita to connect through a websocket to a server, which can then execute
5 | arbitrary Lua within Noita's environment.
6 |
7 | ## Installation (mod / API host)
8 |
9 | The mod dynamically links the [pollws](https://github.com/probable-basilisk/pollws) library through
10 | luajit's FFI in order to act as a websocket client.
11 |
12 | * Grab the [pollws binaries](https://github.com/probable-basilisk/pollws/releases/download/0.1.0/pollws_0_1_0_windows.zip): copy
13 | the *32 bit* `pollws.dll` into your Noita install dir (so it should be in the same directory as `Noita.exe`). You don't need
14 | to care about the includes, bindings, or `.lib` files-- only the `.dll` is needed.
15 |
16 | * Copy the `mod_ws_api` directory into `{your_Noita_install_dir}/mods/`: you should end up with a file in
17 | `{your_Noita_install_dir}/mods/mod_ws_api/mod.xml`.
18 |
19 | * Enable the `mod_ws_api` mod in the Noita mods menu. It will ask for full permissions (in order to use the FFI); presumably
20 | you understand what that means and the risks involved.
21 |
22 | * (optional) Copy the `mod_dev_settings` directory into your mods dir. This mod disables Noita from pausing when
23 | it loses focus, which is very convenient when using the console. Enable this mod also in the Noita mods menu.
24 |
25 | ## Installation (example servers)
26 |
27 | The example servers run on nodejs, so get nodejs installed, and then
28 | ```
29 | cd {the_example_servers_dir}
30 | npm install
31 | ```
32 |
33 | ## Example: webconsole
34 | From the `servers` directory, run:
35 | ```
36 | node main_console.js
37 | ```
38 |
39 | A web browser window should automatically open to a Noita webconsole. Start up Noita (with `mod_ws` enabled),
40 | and then you can directly execute Lua commands from the webconsole. For example, try:
41 |
42 | ```Lua
43 | hello()
44 | GamePrintImportant("Big Message", "Sub Message")
45 | print_entity_info(get_player())
46 | help("EntityGetTransform")
47 | ```
48 |
49 | Note that there is rudimentary command completion with 