diff --git a/README.md b/README.md index a72f5427..3f6d6648 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,61 @@ -# **Arcturus Emulator is released under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.txt). Modifications are allowed but must disclosed. Changes in the about menu are forbidden as they are part of the license.** # - # Arcturus Morningstar # -## Current Stable Version: 1.16 ## -## Current Unstable Version: 2.0.0 ## -Arcturus Morningstar is a Habbo emulator written in Java aiming to be an exact clone of the offical server, based on Arcturus Emulator by TheGeneral. -Targeting PRODUCTION-201611291003-338511768 +## What is Arcturus Morningstar? ## +Arcturus Morningstar is the community project for the Arcturus Emulator by TheGeneral. -### Contributing ### -Anyone is allowed to contribute to the project. Reporting bugs and issues goes via the issue tracker. -Add me on discord if you wish to chat :) capheus#7127 +The community project was made because the Arcturus Emulator has been abandoned by TheGeneral with lack of updates, an intent to monetize the project, and make the project private. -### Credits ### +TheGeneral's own words were "dont like it then dont use it". We did not like what he was doing, so we made our own version. + +## License ## +Arcturus Morningstar is released under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.txt). + +## Versions ## +Stable Version: **1.16** + +Unstable Version: **2.0.0** + +Client build: **PRODUCTION-201611291003-338511768** + +## Reporting problems ## +You can report problems via the Issue Tracker at https://github.com/KrewsOrg/Arcturus-Community/issues + +## Credits ## - TheGeneral - Capheus (Decompilation.) - Harmonic - Beny - Claudio +## Discord ## +Join us on Discord at https://discord.gg/BzfFsTp +## Contributing ## +Anyone is allowed to fork the project and make pull requests. We make no guarantee that pull requests will be approved into the project. + +## Branches ## +There will be 2 branches of the Arcturus Morningstar emulator: + +`master` - The master branch will be the stable branch. Everything here has been tested on a live hotel and contains no known problems. + +`dev` - The dev branch will be the unstable branch. This one is the most up to date, but things may not work as intended. + +There is no set timeframe on when new versions will be released or when the stable branch will be updated. + +## Custom features ## +Do not implement custom features into the source. +A custom feature will be defined as a feature or ability which is not possible in Habbo.com +Use plugins for custom features, and if a plugin is not possible, you should adapt the source to enable plugins to do that. + +## Why always make things as plugins? ## +Why always make things as plugins? +1. Other people will see that plugins are the normal way of adding custom features +2. Plugins can be added and removed at the hotel owner's choice, it makes customizing the hotel easier +3. Developers will be able to read plugin source code to learn how to make their own plugins, without the need to look in complicated source code + +## Making money ## +We have no problem with developers making money through the sale of custom features, plugins or maintenance work. + +Sale of a special edition of a *source code* will not be permitted. You may use your own private edition of a source code, but we will not help you if you have any problems with it. + +If we ever are to make paid features or plugins, we will not prevent or discourage developers from creating alternative options for users.