Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 5.62 KB

README.md

File metadata and controls

96 lines (75 loc) · 5.62 KB
Raw

About

Waitlist for Eve Online targeted towards incursion groups

License

MIT For library licenses see licenses folder

Requirements

  • MySQL/MariaDB (for PosgresSQL the migration might not work, never tested)
  • all the libraries in "requirements.txt"
  • python library to connect to the chosen database
  • node (optional for JS minimization)

Installation

  1. install python >=3.6
  2. install all the requirements by doing pip install -r requirements.txt
  3. install your database connection library (e.g. mysqlclient>=1.3.10)
  4. run python main.py --create-config to create a default config file, this can also be used on version upgrades to add default values for new configuration options without starting up the waitlist.
  5. Create an empty database-scheme in your chosen database server, make sure to use a unicode character set (uf8mb4), utf8mb4 is recommended and not normal utf8 https://mariadb.com/kb/en/library/unicode/ (basically utf8 isn't complete utf8, but utf8mb4 is), the collate to choose depends on which language your users are most likely going to use, it should work with all of them, if you don't know what to take, just leave your database default.
  6. Create a new ESI Application on https://developers.eveonline.com/applications . More information here
  7. open config\config.cfg in your favorite text editor and adjust the settings
  8. run python manager.py db upgrade which creates the database schema
  9. execute python create_admin.py to create the initial admin account. Enter the character name of your main character as account name, then enter the same name as character to associate. When asked for more characters just press enter without entering anything. Further admin accounts can be created over the account management on the website
  10. Use the command pybabel compile -d translations to compile the translation files.
  11. Got to static\js\config\ and create a stattool_config.js (an example file is in there with the options)
  12. Start the waitlist with python main.py and visit it to login with the character that was setup as admin in the previous step.
  13. Now configure groups and permissions :)
  14. Import needed static data! You can find the interface for it under Setting->Static Data Import. The Eve Static Date Export can be found at Eve Resources which you currently only need for the staStations.yaml anymore this will hopefully be removed in the future too. Mandatory are: staStations.yaml and upating typeIds, systems and constellations! The typeIds, systems and constellations are updated via esi and can take quite a while. Updating systems and constellations can fail quietly, so check the error log afterwards.
  15. If you write any improvements committing code back to this project is very much appreciated!

SSO Information

You need to create an application on the CCP 3rd Party Developer Page.

Callback URL:

(path to your waitlist install)/fc_sso/cb

The application needs the following scopes:

  • publicData
  • esi-mail.send_mail.v1
  • esi-fleets.read_fleet.v1
  • esi-fleets.write_fleet.v1
  • esi-ui.open_window.v1

Configuring Waitlist Groups

There is a script called setup_waitlists in the base directory. To create the 3 default waitlist groups, you can just run it with python setup_waitlists.py. If you want your own customized groups, just look at the script and edit it to your need. Currently there is no UI for setting up waitlist groups, but you can change their display name in the fleet settings. Having an UI for this would be nice through, but I haven't gotten around to it yet.

JS Minimization

For the minification used javascript libs are bable and babili, which are both MIT licensed.

  1. Make sure node is installed
  2. Go to the waitlist base directory (the one containing package.json)
  3. npm i

Usage Guide

A small usage guide can be found here You can contribute to the guide buy forking the guide and sending pull requests Please edit the tex only and not the html! HTML modifications will not be accepted

Upgrading

Special Version Upgrades

Pre 1.2.0: Prior to this version only MySQL(and MariaDB) where supported, because of this the needed migration script only supports these databases but should be easily adjustable for others.

If you are upgrading from a version prior to 1.2.0 you need to upgrade you database up to 1.1.4 using the normal migration manager method.

Then you need to run the mysql_upgrade_1.1.4_to_1.2.0.py script that can be found inside the migrations directory. You need to adjust the name of the database inside the script.

Do this from the base waitlist directory you would start main.py from. E.g.: PYTHONPATH=<yourinstalldir_where_main.py_is> python migrations/mysql_upgrade_1.1.4_to_1.2.0.py.

The script will errors about trying to drop a primary index that doesn't exist. I am just trying to drop them in case some one created them manually for some reason. Checking if they exists would just wast time.

After this you can download the current version and use the migration manager again.

1.5.0: Translations where added, this means there is a new setup and upgrade step!

Normal Upgrades

run python manager.py db upgrade and make sure new options added to config.cfg are present in your config file. Some version add new dependencys so you should run pip install -r requirements.txt too. Run pybabel compile -d translations to compile translations!