Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 2.77 KB

README.md

File metadata and controls

93 lines (61 loc) · 2.77 KB

byond-gateway

A gateway server for BYOND's Dream Daemon.

Allows for transmission of an internal server state of any kind, and for this state to be served over HTTP, or alternatively, sent as a remote procedure call.

Building

Windows

You will require TDM-GCC to compile the Dream Daemon library.

To compile the server, run go build -o byond-gateway.exe in server/.

To compile the library:

  • Install TDM-GCC from above.
  • Open up a MinGW command prompt.
  • Go to the directory that you've downloaded the library code to.
  • Run go env -w GOARCH=386 CGO_ENABLED=1.
  • Run go build -o byond-socks.dll -tags netgo -buildmode=c-shared in library/.

The library isn't building on Windows.

Run go mod init byond-socks in library/. Make an issue otherwise if you've already done this.

Linux

To compile the server, run go build -o byond-gateway in server/.

To compile the library, run CGO_ENABLED=1 GOARCH=386 go build -o byond-socks.so -tags netgo -buildmode=c-shared ./ in library/

Where these will be located is dependent on the implementer's choice.

Usage

You can use this in a couple of ways.

Dynamically called from Dream Daemon

/proc/start_rest()
    shell("[byond-rest executable]", "[port]", "[world.port]", "[rpc_port]", "[rpc_call]")

Started separate from Dream Daemon

BYOND_PORT= [ world.port ]
BYOND_GATEWAY_PORT=[ port ]
BYOND_GATEWAY_RPC_PORT=[ rpc_port ]
BYOND_GATEWAY_RPC_CALL=[ rpc_call ]

byond-gateway

After starting, you can send the server messages like so:

/proc/send_rest(S)
    call("[byond-socks library]", "SendAndClose")("127.0.0.1", "[port]", json_encode(S))

where S is a BYOND associative array.

You can access the server's current state via http://localhost:3621/api/status.

If you wish to perform the remote procedure call as indicated by rpc_call, you will need to include a variable status that holds an integer. Whenever this is changed, the server will automatically call rpc_call to a locally hosted server at rpc_port.

JSON RPC is used to make RPCs.

Example code has been included in the examples folder. In there, you can find:

  • a Discord bot
  • an example implementation of byond-gateway in DM

Using examples/dm/byond-rest.dm on a Windows system requires byond-extools.

Why is this split into parts?

I'm not very confident that this could be only a library. I already had some issues trying to use some Go stdlib functions while making the library included (net.Listen causes a crash, while net.ListenTCP does not). Perhaps someday (alternatively, you could try to do this yourself if you really want)

License

Flipp Syder, MIT License, 2021