Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add monster database (long-term goal) #16

Closed
osrsbox opened this issue Jan 21, 2019 · 5 comments
Closed

Add monster database (long-term goal) #16

osrsbox opened this issue Jan 21, 2019 · 5 comments
Assignees
Labels
enhancement monsters Anything to do with the monsters data, API or builder

Comments

@osrsbox
Copy link
Owner

osrsbox commented Jan 21, 2019

It has been a goal of mine to add a bestiary to the osrsbox-db. This process has already begun and have written and added OSRS Wiki data extraction scripts to the extraction_tools_wiki folder. Have also added some base code for the building of the database to the bestiary_db_tools folder.

This issue will be used for notes and updates on progress.

@osrsbox osrsbox self-assigned this Jan 21, 2019
@nwalsh1995
Copy link
Collaborator

I would love to help you on this since I will rely on this database for my own program. If you make more concrete (smaller) issues we can split up the tasks easier.

@osrsbox
Copy link
Owner Author

osrsbox commented Jan 25, 2019

I will work on dividing up the tasks to get a list of subtasks. As a side note, if there are specific data property that is more important to you (e.g., monster attack/defence stats) we could prioritize implementing that part first. Currently, the major challenge (in terms of time and complexity) is cleaning the data extracted from the OSRS Wiki.

@nwalsh1995
Copy link
Collaborator

Okay cool. I am interested in getting Monster defence stats. Eventually will want to have their attack stats, but for now the defence is good.

Let me know if I can help with cleaning the extracted data.

@osrsbox
Copy link
Owner Author

osrsbox commented Jan 25, 2019

Ok! Thanks for letting me know. I will prioritize doing all the stats - both attack and defence as they are so similar to extract. The harder parts are some of the other properties such as drops, slayer master, and weaknesses.

@osrsbox osrsbox added the monsters Anything to do with the monsters data, API or builder label Mar 2, 2019
@osrsbox osrsbox changed the title Add Bestiary to database (long-term goal) Add monster database (long-term goal) Apr 16, 2019
@osrsbox
Copy link
Owner Author

osrsbox commented Aug 19, 2019

This monster database has (finally) been authored. The monsters-database-dev branch has the implemented monster database, and the data has been generated. I think that this addition will require more development in the future, but I think i that it would be useful to PR the development branch into the master/PyPi package to allow easy testing by others.

@nwalsh1995 - it has been a long time since we first started working on this, but if you are still interested, please feel free to provide any feedback.

Some important additions are:

  • docs/monsters-json: All of the individual JSON files with monster data
  • test/monster_schema.json: The JSON schema outlining the properties
  • monsters_builder: Code used to build the monster database from cache and wiki data
  • osrsbox/monsters_api: The Python API for the monster database to be incorporated into the osrsbox PyPi package
  • osrsbox/monsters_api_examples: One simple example of the monsters Python API

One interesting note: There is a property named incomplete that has been added which indicates when the OSRS Wiki is lacking data for a specific monster. After testing, multiple monsters (usually monsters with low popularity) had properties missing, so I added this property to indicate when wiki data was missing.

A selection of additional work is still required to finalize some small things, including:

  • Update osrsbox/README.md to include documentation on monsters database
  • Update README.md to include documentation on monsters database
  • Test PyPi package with the addition of the monsters database

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement monsters Anything to do with the monsters data, API or builder
Projects
None yet
Development

No branches or pull requests

2 participants