ToyBattlesHQ/README.md

Appendix

1. Project Overview

• 1.1 What is this project about?
  • 1.1.1 ToyBattles
  • 1.1.1.1 Team Members
  • 1.1.2 About this emulator
  • 1.1.3 Community Driven - A few videos
• 1.2 Overview of the different projects (MainServer, CastServer, AuthServer, Common)

2. Version History

• 2.1 Changelog from version 1.0 to version 2.0
  • 2.1.1 Complete code refactoring
  • 2.1.2 New Features
  • 2.1.3 Miscellaneous

3. Installation & Setup

• 3.1 Requirements & Installation
  • 3.1.1 Requirements
  • 3.1.2.1 Automatic Installation: Automatic Linux Setup
  • 3.1.2.2 Manual Installation: Windows
  • 3.1.2.3 Manual Installation: Linux
• 3.2 Setting up the emulator
• 3.3 Setting up the database
  • 3.3.1 Windows Setup
  • 3.3.2 Linux Setup
• 3.4 Setting up the client
  • 3.4.1 Downloading the Client
  • 3.4.2 Installing the cgd.dip archive with localhost

4. Configuration Examples

• 4.1 Config setup for localhost
• 4.2 Config setup for VPS
• 4.3 Config setup for multiple servers across different VPSs

5. Database

• 5.1 Tour of database tables

6. Website API

• 6.1 Website API overview and communication with MainServer

7. Updater & Client Tools

• 7.1 The Updater: How the launcher retrieves updates
  • 7.1.1 Overview
  • 7.1.2 Creating Update Packages
  • 7.1.3 Using the Updater
• 7.2 Changing the client version (using the client version tool)
• 7.3 Changing the CGD password (using the password tool)

8. Reporting Issues

• 8.1 How to create bug reports via GitHub Issues
  • 8.1.1 Types of Issues
  • 8.1.2 How to Report an Issue
  • 8.1.3 Found a fix? Feel free to open a PR!

9. Acknowledgements

• 9.1 Credits and community contributions

10. Future steps

• What's next?

Contacts

• For info, contributions or bug reports related to the emulator, please open an issue on this repository.
• For general inquiries, contact us at support@toybattles.net
• For ToyBattles related issues, contact us on our discord server or via https://toybattles.net/support