Skip to content

Commit

Permalink
add README and CONTRIBUTING in english
Browse files Browse the repository at this point in the history
  • Loading branch information
acknowledge committed Oct 19, 2016
1 parent cd2144d commit 8bdf10a
Show file tree
Hide file tree
Showing 4 changed files with 126 additions and 2 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Guide for the contributor
=========================

You can contribute in two different ways :

- Open an issue : If you find something wrong or something that can be done better, just open an [*issue*](https://github.com/rtfmcorp/asylamba-game/issues) and describe as good as you can the problem.
- Propose a PR : If you want to resolve something, you can do it, just follow the precedure down below.


What type of problem can I solve ?
----------------------------------

You can search for an issue you want to solve. In this case, please comment the issue so that we know you're working on it. If there's no issues you can create it.

Here are the things you can do :

- correct orthograph or typing errors
- make refactoring, optimizations
- work on the interface (make it responsive for example)
- create documentation
- optimize the installation process

If you want to add or modify game features, it's likely that the PR will be rejected. If you want to do it, please start a discussion with the dev team first, we'll talk together about what you want to do (open a topic in Asylamba's forum).


How to contribute ?
-------------------

First you need to fork the repo. Then you can work on your version of the game and make commits. When it's done you can submit a pull request on the *dev* branch of the main repo.

The main branch is *master*, the *dev* branch is used for development. We'll not accept PRs on the *master* branch.

*Hint : Make a branch on your fork to do modifications so that you can work on another issue while waiting for the approval/rejection of your PR. Don't forget that all the commits you do on the same branch after the PR will be added to the PR.*

An official guide for the contributions is available [here](https://guides.github.com/activities/contributing-to-open-source/#contributing). If you have any question, don't hesitate to contact us by mail, Asylamba or Discord.


Good practices
--------------

- respect the code conventions (spacing, new lines, tabs, naming)
- the code must be in english (variables names, ...)
- the comments are in english or french
- the commits names must be clear (in french or english)
- a commit modifies/improves one thing, it must be clear and concise
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Voici les différentes choses que vous pouvez faire :

- corriger des fautes d'orthographe ou fautes de frappe
- faire du refactoring, optimisation
- optimiser l'interface (reponse design par exemple)
- optimiser l'interface (reponsive design par exemple)
- créer de la documentation (dans ce cas, il serait mieux de discuter en premier lieu de la technique utilisée, ainsi d'autres personnes pourront vous aider, et vous aurez plus de chance que ça soit accepté)

En ce qui concerne l'ajout ou la modification de fonctionnalités, il est fort probable que ça soit refusé. Si vous souhaitez vous lancer là-dedans, il faut en discuter au préalable avec l'équipe de développement, directement sur le forum du jeu ou sur le serveur Discord d'Asylamba. Cela permettra de ne pas sortir de la ligne directrice.
Expand Down
77 changes: 77 additions & 0 deletions README.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
ASYLAMBA : Expansion Stellaire
==============================

Multiplayer online strategy game. Visit [asylamba.com](http://asylamba.com) to try the game. It's only in French for the moment.

![Asylamba logo](http://asylamba.com/public/media/files/sources/asylambacom.png)

Read this file in other languages : [Français](README.md), [English](README.en.md)

Dependencies
------------

- Apache 2.4.7
- PHP 5.5.9
- MySQL 5.5.49


Installation
------------

Procedure for a local install :

- copy the file `index.default.php` and name it `index.php`, modify the `PUBLICR` constant with your own path
- copy the file `system/config/app.config.local.default.php` and name it `app.config.local.php`, modify the `APP_ROOT` constant and some others if needed (connection to database, and so on.)
- create a database (the name must be the same as the `DEFAULT_SQL_DTB` constant from the last point file)

From there, you can access an interface that permits to create all the SQL tables of the DB : `http://localhost/[votre chemin]/script`. To do the install, click on the first button : "deploy.dbinstall".

If no errors are displayed, you can go to `http://localhost/[votre chemin]/buffer` and create your first players. This interface allows you to connect to each and every player created.

Three scripts are available to update the game on a daily basis, it the ones under the title "Tâches Cron" (cron tasks). You can either launch them by hand or call the related URLs with crons.


Structure of the project
------------------------

The game was developed without any framework for performance and specific needs reasons. There are not many dependencies at that time. We can notice the use of jQuery and LESS for CSS compilation. The rest is in pure HTML/CSS/JavaScript/PHP.

The project contains mainly two folders :

- `public/` : for images, CSS, JavaScript and logs
- `system/` : for views and game core

The `system/` folder contains a lot of sub-folders. It's pretty easy to guess what's inside for most of them. However the `system/modules` folder requires some explanations. It contains the main classes of the game that are grouped by modules. Each one of these modules is called with a greek god name. The list with explanations is just down there.


| Module | Goal |
|-----------|----------|
| Ares | the war (commanders, fights, fleets) |
| Artemis | the spy |
| Athena | the orbital base (orbital base, buildings, commercial shippings, recycling, transactions) |
| Atlas | the rankings (faction, player) |
| Demeter | the factions (elections, law, forums) |
| Gaia | the galaxy (sectors, solar systems, planets) |
| Hermes | the communication (message, notification) |
| Promethee | the technology (research, technologies) |
| Zeus | the joueur (tutorial, bonus management, credit sendings) |


Contribute
----------

If you want to contribute to the project, it's possible ! Thanks to read the [instructions](CONTRIBUTING.en.md) before starting.


Contributors
------------

* [abdelaz3r](https://github.com/abdelaz3r)
* [acknowledge](https://github.com/acknowledge)
* [N03](https://github.com/N03)


License
-------

[WIP]
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Jeu de stragégie en ligne multi-joueur. Visitez [asylamba.com](http://asylamba.

![logo Asylamba](http://asylamba.com/public/media/files/sources/asylambacom.png)

For the english version, follow this link : [English version](README.en.md)

Dépendances
-----------

Expand All @@ -18,7 +20,7 @@ Installation

Procédure pour une installation locale :

- copier `index.default.php` et le renommer en `index.php`, y modifier la constante PUBLICR avec votre chemin
- copier `index.default.php` et le renommer en `index.php`, y modifier la constante `PUBLICR` avec votre chemin
- copier `system/config/app.config.local.default.php` et le renommer `app.config.local.php`, y modifier la constante `APP_ROOT` et d'autres infos (connexion à la base de données, etc.)
- créer une base de données (nom correspondant à la constante `DEFAULT_SQL_DTB` du fichier du point précédent)

Expand Down

0 comments on commit 8bdf10a

Please sign in to comment.