Dark Forest Dev Guides
1.0.0
1.0.0
  • Developing for Dark Forest!
  • Connecting to the blockchain
    • What is an RPC endpoint?
    • Changing your RPC endpoint
    • Running your own xDAI node
  • Plugins
    • What is a plugin?
    • Writing your first plugin
    • Porting v0.5 plugins to v0.6
  • Mining
    • What is mining?
    • Sharing map data
    • Running a headless miner
    • Connecting to a remote (headless) miner
  • Developer resources
    • Running a custom client
    • Developing plugins locally
    • 3rd-party contract development
    • Dark Forest subgraph
    • How to query a subgraph
  • SNARKing
    • Running a remote SNARKer
  • Contributing
    • Contributing to this knowledge base
Powered by GitBook
On this page

Was this helpful?

  1. Plugins

What is a plugin?

PreviousRunning your own xDAI nodeNextWriting your first plugin

Last updated 3 years ago

Was this helpful?

Dark Forest allows players to customize the default webclient via the plugins system. Plugins are snippets of code that players can write to generate alternate views of game data, automate common gameplay flows, or even reskin the game. Essentially, Dark Forest allows players can interact programmatically with the webclient in any way they'd like.

We encourage players to share plugins with the larger community. A community-maintained plugins showcase can be found , with the underlying source code available in . Follow the instructions in the plugins showcase to submit your plugin to the repository.

It's worth noting that plugins are evaluated in the context of your game and can access all of your private information (including your burner wallet private key!). Additionally, plugins can dynamically load data, which can be switched out from under you. Use these plugins at your own risk.

Therefore, it can be dangerous to use any plugins that you haven't written/reviewed yourself or by someone you trust completely. You or someone you trust should control the entire pipeline (such as imported dependencies) and should review plugins before you use them.

here
this repository
README