Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License

About The Project

Built With

• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Installation

1. Clone the repo

   git clone https://github.com/floriaaan/etabli.git
   

2. Install NPM packages

   npm install
   

3. Customize your config in config.ts

4. Build app

   npm run build
   

5. Launch Etabli server

   npm run start
   

(back to top)

Roadmap

• [x] Add web server feature
• [x] Add mod loader support
• [x] Add auto saver support
• [ ] Add core
  • [ ] Entity interfaces (partial)
  • [ ] Player interfaces (partial)
  • [ ] Item interfaces (partial)
  • [ ] Block interfaces (partial)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'feat: add amazing feature')
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

(back to top)

License

Distributed under the AGPL 3.0 License. See LICENSE for more information.

(back to top)