/tibia_monster_loot_item_id

CLI and API to Tibia Items and Monsters. Gabs is currently working to provide full CI/CD Capabilities. Will start with Drone CI.

Primary LanguagePythonMIT LicenseMIT

Contributors Forks Stargazers Issues MIT License LinkedIn Build Status


Logo

Tibia Monster Loot Item ID Discovery (CLI and API) - by Gabs the Creator

Table of Contents
  1. About The Project
  2. Getting Started
  3. How to use the API
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Tech Stack

About The Project

I'm always playing with autoloot State of the Art on OTServers... that's the reason.

Product Name Screen Shot

Postman API all items

Postman API by Name

Postman API by ID

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • python3.6+

  • For MacOs Users, please double-check the SSL CERT

    cd /Applications/Python\ 3.9/ # PUT YOUR PYTHON VERSION
./Install\ Certificates.command

Installation and Usage

  1. Clone the repo 
    git clone https://github.com/gacerioni/tibia_monster_loot_item_id.git
  2. Install the project dependecies (very simple stuff, meant to deal with requests, json, html) 
    pip install -r requirements.txt
  3. Enjoy ;) 
    python main.py
# Demon
<...>
  4. (Optional) If you want to run the API on your local env 
    git clone https://github.com/gacerioni/tibia_monster_loot_item_id.git
cd tibia_monster_loot_item_id
pip install pipenv
sudo pipenv shell
pipenv install --dev
export TIBIA_API_MONGODB_USR="<USER>"
export TIBIA_API_MONGODB_PWD="<PWD>"
cd ./api
uvicorn main:app --reload

How to use the API

TODO

uvicorn main:app --reload

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Gabriel Cerioni - @gabs.tar.gz - gacerioni@gmail.com

Project Link: https://github.com/gacerioni/tibia_monster_loot_item_id/

Tech Stack