Skip to content

Latest commit

 

History

History
121 lines (81 loc) · 2.76 KB

README.md

File metadata and controls

121 lines (81 loc) · 2.76 KB
Raw

Noita Together

Play alone together click here to downloads

What is Noita Together?

Noita Together is an attempt to bring a slight multiplayer aspect to the game, think of it more like everyone is in different dimensions yet you can still see other players and somewhat interact with each other you can not directly affect other player's worlds

it consists of an app made with electron for the twitch authentication and making/joining rooms and some other things and a lua mod that communicates with the app in-game mod uses pollws made by probable-basilisk (fakepyry / pyry)

How to install (click here)

How to use (click here)

FAQ (click here)

Contributing

Electron application

Get setup by running the following:

  • This assumes you have NodeJS installed (Max version for now due to ssl issues: 16.20.0) (Note, later when we update libraries we want to change this)
  • This assumes you have Yarn installed https://yarnpkg.com/getting-started/install
yarn install
yarn client

Configuring your environment

We do NOT version the .env file, so we need to create one :)

Create a .env file at nt-app/

VUE_APP_HOSTNAME=http://localhost:3000/api
VUE_APP_WS_PORT=:5466
VUE_APP_HOSTNAME_WS=localhost

TODO github actions setup

Backend

First time setup

yarn install
yarn serverInitOnce

Running the server

yarn install
yarn server

Using dockerfile to test pm2:

docker build .

Then you want to start the container, binding port 3000 and port 5466 https://docs.docker.com/engine/reference/commandline/run/

Updating the protobuf file

Please only make changes at protobuf/messages.proto

Then after changes are complete, run yarn build-proto

Version the following file changes if they appear:

nt-web-app/websocket/messages.d.ts
nt-web-app/websocket/messages.js
nt-app/public/messages.proto

Configuring your environment

We do NOT version the .env file, so we need to create one :)

Create a .env file at nt-app/

TWITCH_API_KEY=
TWITCH_CLIENT_ID=
OAUTH_REDIRECT_URI=http://localhost:3000/api/authenticate
WEBSERVER_AUTH_URL=http://localhost:3000
NOITA_APP_REDIRECT_URI=http://localhost:25669

TODO github actions setup

Noita Mods

Building new mods

run the following:

yarn install
node ./build-mods.js

Commit the following files afterwards:

noita_mod/core/manifest.json
noita_mod/nemesis/manifest.json

Core mod

Location: noita_mod/core

Nemesis

Location: noita_mod/nemesis