Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 3.14 KB

README.md

File metadata and controls

100 lines (71 loc) · 3.14 KB
Raw

tibiawiki-sql

Script that generates a sqlite database for the MMO Tibia.

Inspired in Mytherin's Tibiaylzer TibiaWiki parsing script.

This script fetches data from TibiaWiki via its API, compared to relying on database dumps that are not updated as frequently. By using the API, the data obtained is always fresh.

This script is not intended to be running constantly, it is meant to be run once, generate a sqlite database and use it externally.

If you integrate this into your project or use the generated data, make sure to credit TibiaWiki and its contributors.

Build Status GitHub (pre-)release PyPI PyPI - Python Version PyPI - License

Requirements

  • Python 3.6 or higher
    • requests module
    • click module
    • colorama module

Installing

To install the latest version on PyPi:

pip install tibiawikisql

or

Install the latest version from GitHub

pip install git+https://github.com/Galarzaa90/tibiawiki-sql.git

Running

python -m tibiawikisql generate

OR

tibiawikisql

The process can be long, taking up to 10 minutes the first time. All images are saved to the images folder. On subsequent runs, images will be read from disk instead of being fetched from TibiaWiki again. If a newer version of the image has been uploaded, it will be updated.

When done, a database file called tibiawiki.db will be found on the folder.

Docker

Docker Pulls Docker Image Size (latest semver)

The database can also be generated without installing the project, it's dependencies, or Python, by using Docker. Make sure to have Docker installed, then simply run:

generateWithDocker.sh

The script will build a Docker image and run the script inside a container. The tibiawiki.db file will end up in the project's root directory as normal.

Database contents

  • Achievements
  • Charms
  • Creatures
  • Creature drop statistics
  • Houses
  • Imbuements
  • Items
  • Mounts
  • NPCs
  • NPC offers
  • Outfits
  • Quests
  • Spells
  • Updates
  • Worlds

Documentation

Check out the documentation page.

Contributing

Improvements and bug fixes are welcome, via pull requests
For questions, suggestions and bug reports, submit an issue.

The best way to contribute to this project is by contributing to TibiaWiki.

image