diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6edf9c39b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ +# Contributing + +TODO... + +See [emulator operation](doc/Organisation%20émulateur.pdf). + +***Note:** In french, not yet translated* \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 000000000..8e3a2cb60 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +# Araknemu [![Build Status](https://scrutinizer-ci.com/g/Arakne/Araknemu/badges/build.png?b=master)](https://scrutinizer-ci.com/g/Arakne/Araknemu/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Arakne/Araknemu/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Arakne/Araknemu/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/Arakne/Araknemu/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Arakne/Araknemu/?branch=master) + +A simple open source Dofus 1.29 server emulator, implementing only base features, with high quality standard. + +## Getting started + +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. + +### Prerequisites + +- Java JDK >= 8 +- Maven +- Git +- MySQL (or MariaDB) + +### Installing + +***Note:** Those instruction permit to setup a development environment, not a production one* + +- Clone the repository and go to the project directory + ``` + git clone https://github.com/Arakne/Araknemu.git && cd Araknemu + ``` +- Build the JAR + ``` + mvn package -DskipTests=true + ``` +- Create database and configure the `conf.ini` file (The database is not provided) + +### Running + +Launch the built jar. +To run the server, your working directory should contains the `conf.ini` file. + +``` +java -jar target/araknemu-0.6-alpha-jar-with-dependencies.jar +``` + +## About the project + +### Project state + +The project is in pre-alpha development state, so the architecture is not stable, and will change until the v1.0 is released. +It can be used only for testing or development purpose. + +### Features + +To see all currently implemented features you can go to [closed feature issues](https://github.com/Arakne/Araknemu/issues?q=is%3Aissue+is%3Aclosed+label%3AFeature). + +- Monolithic server with game and auth server +- Player + - Creation and deletion + - Experience and level up + - Characteristics (per class) + - Learn and upgrade spells + - Exchange +- Maps + - Teleportation plot + - Teleport admin on double click +- NPC + - Dialog + - Store + - Exchange + - Dungeon +- Chat channels (private, map, trade, recruitment, admin...) +- Items + - Characteristics + - Usable items (i.e. potions) + - Item sets +- Bank +- Fight + - Duel + - PvM + - AI + - [Spell effects](https://github.com/Arakne/Araknemu/issues/27) + +### Questions & answers + +#### Where is the database ? + +This project only provide the server source code. You should create your own database for launch the server. +A command will be created for generates the database structure. + +#### Why this project ? There is a lot of other dofus emulators... + +All dofus servers I've seen have very bad quality standard, not following semantic versioning, +always on rolling release (i.e. no maintained version), and no unit and functional tests. +So, the goal of this project is to provide a reliable open source base for Dofus servers. + +## Contributing + +Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. + +## Licence + +This project is licensed under the LGPLv3 licence. See [COPYING](./COPYING) and [COPYING.LESSER](./COPYING.LESSER) files for details. \ No newline at end of file diff --git "a/doc/Organisation \303\251mulateur.pdf" "b/doc/Organisation \303\251mulateur.pdf" new file mode 100644 index 000000000..47ff65058 Binary files /dev/null and "b/doc/Organisation \303\251mulateur.pdf" differ