Skip to content

README.md

Latest commit

 

History

History
74 lines (51 loc) · 2.22 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.22 KB

Work-in-progress Rec Room server replacement for 2017 builds.

Important

Coach's Time Machine servers are not designed for production use.

These servers are designed to be basic enough get builds working again. Every server is designed to work for multiple connections though (this aint OpenRec or RecJS).

The ideal use for CTM servers is personal and small scale usage (like with friends). You can also use it as a "template" to build your own servers from.

If you don't know what "production use" means, you probably shouldnt try making a Rec Room revival.

Installing

Note

You will also need to have node-gyp installed on your system, which comes with node-js.

I'll fix this when development is getting closer to finished.

This project requires Bun to be installed on your system.

Install the required dependencies by running:

$ bun install # Downloads required dependencies, along with types.

# Alternatively, you can use:
$ bun install --production # Only downloads required dependencies.

Next, build the database by running:

$ bun run build-db

Note

Databases will eventually be reworked to use migrations.

You now need to create your .env file. You'll get errors if it is not created!!

You can run the server with:

$ bun .

.env

Copy and paste this into a new file called .env.

PORT_HTTP = 3000
PORT_WS = 3001

JWT_SECRET = "CTM_JWT_SECRET_CHANGE_ME"
AMPLITUDE_KEY = "" # You can leave this blank to leave out logging. Will cause the client to warn a lot though.

IGNORE_VERSION_CHECK = "true " #set to false to restrict to single version
VERSION_CHECK = "" #will be ignored if IGNORE_VERSION_CHECK is set to true (duh)

MOTD = "Welcome to Coach's Time Machine!"