zakirkun / GrowServer

A Growtopia private server using NodeJS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GrowServer

A Growtopia private server using Node.js

Requirements

  • Node.js v16+

Setup

To setup the server, first install necessary packages & settings by

$ npm install

And congrats setup are done, simple as that! Now you just need to run the server by

$ npm run dev

Enviroment file

Example for default .env file (Generated automatically)

ENCRYPT_SECRET=SUPERSECRET # Default encrypt secret
WEB_ADDRESS=127.0.0.1
WEB_ENV=development

Database

Database that we currently use is SQLite3, since its easier & light. And for the SQL query builder we use Knex.js

Starting server

To run the development server by

$ npm run dev

Growtopia assets cache

Where the heck is assets/cache.zip come from? Its basically a growtopia assets file cache that required by items.dat to load the game.

Example

Location:

  • Windows: %LOCALAPPDATA%/Growtopia

Then zip the cache folder into zip & put it to assets/cache.zip.

Issue

If you encountered Updating items... then disconnected from the server randomly. Update the cache by login to Growtopia's original server & do this step again.

Contributing

Any contributions are welcome.

There's few rules of contributing:

  • Code must match the existing code style. Please make sure to run npm run lint before submiting a PR.
  • The commit must take review first before merging into main branch.

Links

Credits

Give a thumbs to these cool people:

About

A Growtopia private server using NodeJS

License:MIT License


Languages

Language:TypeScript 96.5%Language:JavaScript 3.0%Language:EJS 0.5%