Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 3.43 KB

MANUAL.md

File metadata and controls

47 lines (31 loc) · 3.43 KB
Raw

Rplace.live custom server manual.

⚠️ Note: Alternative server is out! Check out the new official server software for a quick and easy way to set up rplace yourself.

Preramble:

Setting up a custom server that users can connect to via the posts menu is very possible provided you follow the rules outlined in the README, this guide will help you along the way of setting up a shiny custom rplace server, with whatever canvas, chat or cooldown rules you like!

Important notes:

  • To run a rplace custom server, you require:
    • Acess to a server or PC capable of running bun (support may only be available on windows under WSL).
    • Acess to your routers/server's port forwarding rules in order to connect your custom server to the internet.
    • A web domain for https connections (will be outlined later in this document).
  • If you encounter a bug, please ask us on the discord or submit a github issue.
  • Make sure that you are running the latest versions of runtimes and libraries, such as the latest bun, or you may encounter issues.
  • Read the instructions carefully, the order of what you do does matter.

Setting up the server:

  1. Get a web domain, this can be done by visiting free domain sites such as noip.com: image

  2. Port forward ports 80 (will be used by certbot), 443 (web socket), 8080 (place file server) to the computer you decide to use to host the server image image

  3. Install the latest versions of certbot, bun, npm, and git on your system.

image

  1. Use certbot to set up the keys and certificates on the computer you would like to use

image

  1. Clone the project with git. This can be done with git clone https://rslashplace2/rslashplace2.github.io

  2. Enter the cloned project directory with cd rslashplace2.github.io. Run bun i and npm i to install all required packages respectively.

  3. Run the server with bun run server.js

  4. On initial run, the server will ask you to configure a server_config.json file. Insert all required details, such as the certificate and key paths generated by certbot, the github key and repo which canvas backups should be pushed to and all other required information.

  5. Once configured, run the server again with bun run server.js. If your certificate and key have been located in root directories, administator privilages may be required, this can be solved by running bun with sudo, or using an administrator terminal session on windows.

  6. If you encountered no errors, Bon Voilà, you have set up an rplace custom server acessable from in the game.

  7. If you did encounter errors, no worries, visit the rplace discord, acessable through out site https://rplace.live and ask one of the admins (our usernames are usually @BlobKat/@zekiahepic), and we will try our best to assist you!