Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
exoRift committed Nov 22, 2024
2 parents e800232 + f865239 commit 03c6079
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 3 deletions.
12 changes: 12 additions & 0 deletions documentation/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ Websocket URLs generally follow this structure: `ws://123.456.789.10:1234` where
## Running the server
The server can be started by running the executable provided to you. By default, it will use port 5000. If port 5000 is taken, use the command line to run the file and you can supply a port number afterward to switch the port.

> [!TIP]
> If Windows gives you gripe, click "More Info" and then click "Run Anyway"
> ![windows security](windows_security.png)
## General behavior
> [!TIP]
> For the sake of convencience, imagine all subsequent occurences of "IP" are the server's IP.
Expand Down Expand Up @@ -47,6 +51,14 @@ Games can be observed in realtime at https://exoRift.github.io/mindsmachines-con

The website will prompt you for the server IP. Make sure you use the numeric IP logged to the console when starting the server executable. (without the `http://`)

> [!CAUTION]
> By default, browsers will not allow a website to make requests to insecure servers. To override this (Chrome example),
> click on the settings button next to the URL and go to "site settings"
> ![step 1](security_step1.png)
> then scroll down to "insecure content" and switch it to "Allow"
> ![step 2](security_step2.png)

When a game is created, it will appear in the menu and can be clicked on to spectate. If there's no second player, the game can be joined by clicking the Join Game button in the top right.

Games can also be created by clicking Create Game at the bottom of the main menu.
Expand Down
Binary file added documentation/security_step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/security_step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/windows_security.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 0 additions & 3 deletions pkgconfig.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
{
"pkg": {
"targets": [
"node20-linux-x64",
"node20-macos-x64",
"node20-macos-arm64",
"node20-win-x64"
],
"scripts": "src/server/**/*.js"
Expand Down

0 comments on commit 03c6079

Please sign in to comment.