Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.26 KB

README.md

File metadata and controls

59 lines (36 loc) · 2.26 KB
Raw

Dark Forest Client

Development Guide

Installing Core Dependencies

  • Node (v14.x OR v16.x)
  • Yarn (Javascript Package Manager)

Installing The Correct Node Version Using NVM

Dark Forest is built and tested using Node.js v14/v16 and might not run properly on other Node.js versions. We recommend using NVM to switch between multiple Node.js version on your machine.

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.35.3/install.sh | bash
nvm install

After the installation is finished, you can run node --version to verify that you are running v14 or v16

Installing Yarn

Refer to Yarn's official documentation for the installation guide.

After you have Yarn installed, run yarn to install the dependencies:

Running the client

To connecting to the mainnet client, simply run yarn start:prod. When asked you can use your whitelist key or import your mainnet burner secret and home coordinates.

Plugin development

You can develop plugins for Dark Forest either inside this game client repository, or externally using something like https://github.com/Bind/my-first-plugin. In either case, you'll want to use the df-plugin-dev-server.

You can install it as a global command, using:

npm install -g @projectsophon/df-plugin-dev-server

Once it is installed, you can run it inside this project repository, using:

df-plugin-dev-server

You can then add or modify any plugins inside the plugins/ directory and they will be automatically bundled and served as plugins you can import inside the game!

And then load your plugin in the game client, like so:

// Replace PluginTemplate.js with the name of your Plugin
// And `.ts` extensions become `.js`
export { default } from 'http://127.0.0.1:2222/PluginTemplate.js?dev';

Embedded plugins

The Dark Forest client ships with some game "plugins" embedded in the game client. The source code for these plugins exists at embedded_plugins/. You are able to edit them inside the game and the changes will persist. If you change the source code directly, you must delete the plugin in-game and reload your browser to import the new code.