Let's yeet some history
This commit is contained in:
commit
4b990990cf
23012 changed files with 20003 additions and 0 deletions
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
# Set the default behavior, in case people don't have core.autocrlf set.
|
||||
* text=auto
|
||||
36
.github/workflows/deploy-pypi.yml
vendored
Normal file
36
.github/workflows/deploy-pypi.yml
vendored
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
name: Build and Deploy to PyPI
|
||||
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
|
||||
build-and-publish:
|
||||
name: Build and deploy to PyPI
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 1
|
||||
|
||||
- name: Set up Python 3.7
|
||||
uses: actions/setup-python@v2
|
||||
with:
|
||||
python-version: 3.7
|
||||
|
||||
- name: Install Poetry
|
||||
uses: snok/install-poetry@v1.1.1
|
||||
|
||||
- name: Install Dependencies
|
||||
run: poetry install
|
||||
|
||||
- name: Build Package
|
||||
run: poetry build
|
||||
|
||||
- name: Deploy to PyPI
|
||||
uses: pypa/gh-action-pypi-publish@master
|
||||
with:
|
||||
password: ${{ secrets.pypi_password }}
|
||||
skip_existing: true
|
||||
142
.gitignore
vendored
Normal file
142
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
# osrsbox-db custom additions
|
||||
.vscode/
|
||||
data/cache/cache-data/
|
||||
data/cache/items/
|
||||
data/cache/npcs/
|
||||
data/cache/objects/
|
||||
data/monsters/monsters-drops-raw
|
||||
data/monsters/monsters-wiki-page-text-processed.json
|
||||
data/items/items-wiki-page-text-processed.json
|
||||
data/**
|
||||
docs/**
|
||||
monsters-complete.json
|
||||
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
pip-wheel-metadata/
|
||||
share/python-wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
MANIFEST
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.nox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
*.py,cover
|
||||
.hypothesis/
|
||||
.pytest_cache/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Django stuff:
|
||||
*.log
|
||||
local_settings.py
|
||||
db.sqlite3
|
||||
db.sqlite3-journal
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# IPython
|
||||
profile_default/
|
||||
ipython_config.py
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# pipenv
|
||||
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
||||
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
||||
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
||||
# install all needed dependencies.
|
||||
#Pipfile.lock
|
||||
|
||||
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
||||
__pypackages__/
|
||||
|
||||
# Celery stuff
|
||||
celerybeat-schedule
|
||||
celerybeat.pid
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
.dmypy.json
|
||||
dmypy.json
|
||||
|
||||
# Pyre type checker
|
||||
.pyre/
|
||||
12
.gitmodules
vendored
Normal file
12
.gitmodules
vendored
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
[submodule "data/schemas"]
|
||||
path = data/schemas
|
||||
url = https://github.com/osrsbox/schemas.git
|
||||
[submodule "data/cache/osrs-cache"]
|
||||
path = data/cache/osrs-cache
|
||||
url = https://github.com/abextm/osrs-cache.git
|
||||
[submodule "data/cache/osrs-flatcache"]
|
||||
path = data/cache/osrs-flatcache
|
||||
url = https://github.com/abextm/osrs-flatcache.git
|
||||
[submodule "runelite"]
|
||||
path = runelite
|
||||
url = https://github.com/runelite/runelite/
|
||||
8
.idea/.gitignore
generated
vendored
Normal file
8
.idea/.gitignore
generated
vendored
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
# Default ignored files
|
||||
/shelf/
|
||||
/workspace.xml
|
||||
# Editor-based HTTP Client requests
|
||||
/httpRequests/
|
||||
# Datasource local storage ignored files
|
||||
/dataSources/
|
||||
/dataSources.local.xml
|
||||
6
.idea/inspectionProfiles/profiles_settings.xml
generated
Normal file
6
.idea/inspectionProfiles/profiles_settings.xml
generated
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
<component name="InspectionProjectProfileManager">
|
||||
<settings>
|
||||
<option name="USE_PROJECT_PROFILE" value="false" />
|
||||
<version value="1.0" />
|
||||
</settings>
|
||||
</component>
|
||||
4
.idea/misc.xml
generated
Normal file
4
.idea/misc.xml
generated
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectRootManager" version="2" project-jdk-name="3.10 @ Ubuntu-CommPrev (2)" project-jdk-type="Python SDK" />
|
||||
</project>
|
||||
8
.idea/modules.xml
generated
Normal file
8
.idea/modules.xml
generated
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="ProjectModuleManager">
|
||||
<modules>
|
||||
<module fileurl="file://$PROJECT_DIR$/.idea/osrsbox-db.iml" filepath="$PROJECT_DIR$/.idea/osrsbox-db.iml" />
|
||||
</modules>
|
||||
</component>
|
||||
</project>
|
||||
13
.idea/osrsbox-db.iml
generated
Normal file
13
.idea/osrsbox-db.iml
generated
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<module type="PYTHON_MODULE" version="4">
|
||||
<component name="NewModuleRootManager">
|
||||
<content url="file://$MODULE_DIR$">
|
||||
<sourceFolder url="file://$MODULE_DIR$/builders" isTestSource="false" />
|
||||
<sourceFolder url="file://$MODULE_DIR$/scripts" isTestSource="false" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/data" />
|
||||
<excludeFolder url="file://$MODULE_DIR$/docs" />
|
||||
</content>
|
||||
<orderEntry type="jdk" jdkName="3.10 @ Ubuntu-CommPrev (2)" jdkType="Python SDK" />
|
||||
<orderEntry type="sourceFolder" forTests="false" />
|
||||
</component>
|
||||
</module>
|
||||
10
.idea/vcs.xml
generated
Normal file
10
.idea/vcs.xml
generated
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="VcsDirectoryMappings">
|
||||
<mapping directory="$PROJECT_DIR$" vcs="Git" />
|
||||
<mapping directory="$PROJECT_DIR$/data/cache/osrs-cache" vcs="Git" />
|
||||
<mapping directory="$PROJECT_DIR$/data/cache/osrs-flatcache" vcs="Git" />
|
||||
<mapping directory="$PROJECT_DIR$/data/schemas" vcs="Git" />
|
||||
<mapping directory="$PROJECT_DIR$/runelite" vcs="Git" />
|
||||
</component>
|
||||
</project>
|
||||
15
.idea/webResources.xml
generated
Normal file
15
.idea/webResources.xml
generated
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project version="4">
|
||||
<component name="WebResourcesPaths">
|
||||
<contentEntries>
|
||||
<entry url="file://$PROJECT_DIR$">
|
||||
<entryData>
|
||||
<resourceRoots>
|
||||
<path value="file://$PROJECT_DIR$/docs" />
|
||||
<path value="file://$PROJECT_DIR$/data" />
|
||||
</resourceRoots>
|
||||
</entryData>
|
||||
</entry>
|
||||
</contentEntries>
|
||||
</component>
|
||||
</project>
|
||||
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
1
MANIFEST.in
Normal file
1
MANIFEST.in
Normal file
|
|
@ -0,0 +1 @@
|
|||
include LICENSE osrsbox/docs/items-complete.json osrsbox/docs/monsters-complete.json osrsbox/docs/prayers-complete.json README.md
|
||||
925
README.md
Normal file
925
README.md
Normal file
|
|
@ -0,0 +1,925 @@
|
|||
# osrsbox-db
|
||||
|
||||
 
|
||||
|
||||
[](https://badge.fury.io/py/osrsbox) 
|
||||
|
||||
[](https://discord.gg/HFynKyr)
|
||||
|
||||
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9J44ADGJQ5BC6&source=url)
|
||||
|
||||
## A complete and up-to-date database of Old School Runescape (OSRS) items, monsters and prayers
|
||||
|
||||
This project hosts a complete and up-to-date database items, monsters and prayers in OSRS. **Complete** means it holds every single item, monster and prayer in OSRS. **Up-to-date** means this database is updated after every weekly game update to ensure accurate information.
|
||||
|
||||
The item database has extensive properties for each item: a total of 27 properties for every item, an additional 16 properties for equipable items, and an additional 3 properties for equipable weapons. These properties include the item ID and name, whether an item is tradeable, stackable, or equipable or if the item is members only. For any equipable item, there are additional properties about combat stats; for example, what slash attack bonus, magic defence bonus or prayer bonus that an item provides. For weapons, additional properties are added which include attack speed, combat stance and weapon type information.
|
||||
|
||||
The monster database also has extensive properties: a total of 44 unique properties for each monster, as well as an array of item drops for each monster that has 6 additional properties per item drop. The base properties include the monster ID, name, member status, slayer properties, attack type, max hit, attack types and all monster combat stats. Each monster also has an associated array of drops which document the item ID, name, rarity, quantity, and any requirements to get the drop.
|
||||
|
||||
The prayer database documents each prayer that available in-game and has detailed properties: a total of 8 properties for every prayer. The base properties include the prayer name, members status, description, requirements, and bonuses that it provides.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Project Summary](#project-summary)
|
||||
- [The `osrsbox` Python PyPi Package](#the-osrsbox-python-pypi-package)
|
||||
- [The osrsbox RESTful API](#the-osrsbox-restful-api)
|
||||
- [The osrsbox Static JSON API](#the-osrsbox-static-json-api)
|
||||
- [The `osrsbox-db` GitHub Repository](#the-osrsbox-db-github-repository)
|
||||
- [The Item Database](#the-item-database)
|
||||
- [The Monster Database](#the-monster-database)
|
||||
- [The Prayer Database](#the-prayer-database)
|
||||
- [Project Contribution](#project-contribution)
|
||||
- [Additional Project Information](#additional-project-information)
|
||||
|
||||
## Project Summary
|
||||
|
||||
The osrsbox-db project provides data for three different categories:
|
||||
|
||||
1. **Items**
|
||||
1. **Monsters**
|
||||
1. **Prayers**
|
||||
|
||||
The osrsbox-db project and data is accessible using four methods:
|
||||
|
||||
1. [**The Python PyPi package**](https://pypi.org/project/osrsbox/)
|
||||
1. [**The RESTful API**](https://github.com/osrsbox/osrsbox-api/)
|
||||
1. [**The Static JSON API**](https://github.com/osrsbox/osrsbox-db/tree/master/docs)
|
||||
1. [**The GitHub development repository**](https://github.com/osrsbox/osrsbox-db/)
|
||||
|
||||
With four different methods to access data... most people will have the following question: _Which one should I use?_ The following list is a short-sharp summary of the options:
|
||||
|
||||
1. [**The Python PyPi package**](https://pypi.org/project/osrsbox/): Use this if you are programming anything in Python - as it is the simplest option. Install using `pip`, and you are ready to do anything from experimenting and prototyping, to building a modern web app using something like Flask.
|
||||
1. [**The RESTful API**](https://github.com/osrsbox/osrsbox-api/): Use this if you are not programming in Python, and want an Internet-accessible API with rich-quering including filtering, sorting and projection functionality.
|
||||
1. [**The Static JSON API**](https://github.com/osrsbox/osrsbox-db/tree/master/docs): Use this if you want Internet-accessible raw data (JSON files and PNG images) and don't need queries to filter data. This is a good option if you want to _dump_ the entire database contents, and saves the RESTful API from un-needed traffic.
|
||||
1. [**The GitHub development repository**](https://github.com/osrsbox/osrsbox-db/): The development repository provides the code and data to build the database. I would not recommend using the development repository unless you are (really) interested in the project or you want to contribute to the project.
|
||||
|
||||
## The `osrsbox` Python PyPi Package
|
||||
|
||||
If you want to access the item and monster database programmatically using Python, the simplest option is to use the [`osrsbox` package available from PyPi](https://pypi.org/project/osrsbox/). You can load the item and/or monster database and process item objects, monster objects, and their properties.
|
||||
|
||||
### Package Quick Start
|
||||
|
||||
- Make sure you have >= Python 3.6
|
||||
- Install package using: `pip install osrsbox`
|
||||
- Item database quick start:
|
||||
- Import items API using: `from osrsbox import items_api`
|
||||
- Load all items using: `items = items_api.load()`
|
||||
- Loop items using: `for item in items: print(item.name)`
|
||||
- Monster database quick start:
|
||||
- Import monsters API using: `from osrsbox import monsters_api`
|
||||
- Load all monsters using: `monsters = monsters_api.load()`
|
||||
- Loop monsters using: `for monster in monsters: print(monster.name)`
|
||||
- Prayer database quick start:
|
||||
- Import prayers API using: `from osrsbox import prayers_api`
|
||||
- Load all prayers using: `prayers = prayers_api.load()`
|
||||
- Loop prayers using: `for prayer in prayers: print(prayer.name)`
|
||||
|
||||
### Package Requirements
|
||||
|
||||
For the `osrsbox` PyPi package you must meet the following requirements:
|
||||
|
||||
- Python 3.6 or above
|
||||
- Pip package manager
|
||||
- Dataclasses package (if Python is below 3.7)
|
||||
|
||||
If you are using Python 3.6, the `dataclasses` package will automatically be installed. If you are using Python 3.7 or above, the `dataclasses` package is part of the standard library and will not be installed automatically.
|
||||
|
||||
### Package Installation
|
||||
|
||||
The easiest way to install the osrsbox package is through the [Python Package Index](http://pypi.python.org/) using the `pip` command. You need to have `pip` installed - and make sure it is updated (especially on Windows). Then you can install the `osrsbox` package using the following `pip` command:
|
||||
|
||||
```
|
||||
pip install osrsbox
|
||||
```
|
||||
|
||||
### Package Upgrading
|
||||
|
||||
The package is consistently updated - usually after each weekly in-game update. This is because the in-game update usually introduces additional items into the game or changes existing items. Therefore, you should regularly check and update the `osrsbox` package. To achieve this, run `pip` with the `upgrade` flag, as demonstrated in the following command:
|
||||
|
||||
```
|
||||
pip install --upgrade osrsbox
|
||||
```
|
||||
|
||||
### Package Usage
|
||||
|
||||
The key use of the `osrsbox` package is to load and automate the processing of OSRS items and their associated metadata. You can load the package using `import osrsbox`, however, you probably want to load the `items_api` module or `monsters_api` module. A simple example of using the package to `load` all the items, then loop and print out the item ID and name of every item in OSRS is provided below:
|
||||
|
||||
```
|
||||
phoil@gilenor ~ $ python3.6
|
||||
Python 3.6.8 (default, Jan 14 2019, 11:02:34)
|
||||
[GCC 8.0.1 20180414 (experimental) [trunk revision 259383]] on linux
|
||||
Type "help", "copyright", "credits" or "license" for more information.
|
||||
>>> from osrsbox import items_api
|
||||
>>> items = items_api.load()
|
||||
>>> for item in items:
|
||||
... print(item.id, item.name)
|
||||
```
|
||||
|
||||
Instead of using the Python interpreter, you can also write a simple script and import the `osrsbox` Python package. An example script is provided below, this time for the `monsters_api`:
|
||||
|
||||
```
|
||||
#!/usr/bin/python3
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
monsters = monsters_api.load()
|
||||
for monster in monsters:
|
||||
print(monster.id, monster.name)
|
||||
```
|
||||
|
||||
If you would like to review additional examples of using the `osrsbox` Python API, have a look at the [`items_api_examples` folder](https://github.com/osrsbox/osrsbox-db/tree/master/osrsbox/items_api_examples) and [`monsters_api_examples` folder](https://github.com/osrsbox/osrsbox-db/tree/master/osrsbox/monsters_api_examples). There are a number of scripts available that provide examples of loading and processing data using the Python API.
|
||||
|
||||
## The osrsbox RESTful API
|
||||
|
||||
The [official osrsbox-api GitHub repository](https://github.com/osrsbox/osrsbox-api) hosts the source code used for the RESTful API. The official `osrsbox-api` project is available from:
|
||||
|
||||
- [https://api.osrsbox.com](https://api.osrsbox.com)
|
||||
|
||||
The link provided above has an API landing page with detailed information on the project including a project summary, API endpoints, and links to useful documentation. Also, have a look at the [official `osrsbox-api` project README](https://github.com/osrsbox/osrsbox-api/blob/master/README.md) for more information. The README has a tutorial on how to build the API docker environment locally for testing purposes which might be useful.
|
||||
|
||||
## The `osrsbox` Static JSON API
|
||||
|
||||
This project also includes an Internet-accessible, static JSON API for all items/monsters in the database. The JSON API was originally written for the [`osrsbox-tooltips` project](https://github.com/osrsbox/osrsbox-tooltips) but has since been used for a variety of other projects. The JSON API is useful when you do not want to write a program in Python (as using the PyPi package is probably easier), but would like to fetch the database information programmatically over the Internet, and receive the data back in nicely structured JSON syntax. A key example is a web application.
|
||||
|
||||
### Static JSON API Files
|
||||
|
||||
The JSON API is available in the [`docs` folder](https://github.com/osrsbox/osrsbox-db/tree/master/docs/) in the osrsbox-db project repository. This folder contains the publicly available database. Every file inside this specific folder can be fetched using HTTP GET requests. The base URL for this folder is `https://www.osrsbox.com/osrsbox-db/`. Simply append any name of any file from the `docs` folder to the base URL, and you can fetch this data. A summary of the folders/files provided in the JSON API are listed below with descriptions:
|
||||
|
||||
- `items-complete.json`: A single JSON file that combines all single JSON files from `items-json` folder. This file contains the entire osrsbox-db items database in one file. This is useful if you want to get the data for every single item.
|
||||
- `items-icons`: Collection of PNG files (20K+) for every item inventory icon in OSRS. Each inventory icon is named using the unique item ID number.
|
||||
- `items-json`: Collection of JSON files (20K+) of extensive item metadata for every item in OSRS. This folder contains the entire osrsbox-db item database where each item has an individual JSON file, named using the unique item ID number. This is useful when you want to fetch data for a single item where you already know the item ID number.
|
||||
- `items-json-slot`: Collection of JSON files extracted from the database that are specific for each equipment slot (e.g., head, legs). This is useful when you want to only get item data for equipable items for one, or multiple, specific item slot.
|
||||
- `items-summary.json`: A single JSON file that contains only the item names and item ID numbers. This file is useful when you want to download a small file (1.1MB) to quickly scan/process item data when you only need the item name and/or ID number.
|
||||
- `models-summary.json`: A single JSON file that contains model ID numbers for items, objects, and NPCs. This file is useful to determine the model ID number for a specific item, object or NPC.
|
||||
- `monsters-complete.json`: A single JSON file that combines all single JSON files from the `monsters-json` folder. This file contains the entire osrsbox-db monster database in one file. This is useful if you want to get the data for every single monster in one file.
|
||||
- `monsters-json`: Collection of JSON files (2.5K+) of extensive monster metadata for every monster in OSRS. This folder contains the entire osrsbox-db monster database where each monster has an individual JSON file, named using the unique monster ID number. This is useful when you want to fetch data for a single monster where you already know the item ID number.
|
||||
- `npcs-summary.json`: A single JSON file that contains only the NPC names and NPC ID numbers. This file is useful when you want to download a small file (0.35MB) to quickly scan/process NPC data when you only need the NPC name and/or ID number. Note that this file contains both attackable, and non-attackable (monster) NPCs.
|
||||
- `objects-summary.json`: A single JSON file that contains only the object names and object ID numbers. This file is useful when you want to download a small file (0.86MB) to quickly scan/process in-game object data when you only need the object name and/or ID number.
|
||||
- `prayer-icon`: Collection of PNG files for each prayer in OSRS.
|
||||
- `prayer-json`: Collection of individual JSON files with properties and metadata about OSRS prayers.
|
||||
|
||||
### Accessing the Static JSON API
|
||||
|
||||
The JSON file for each OSRS item can be directly accessed using unique URLs provide through the [`osrsbox.com`](https://www.osrsbox.com/osrsbox-db/) base URL. As mentioned, you can fetch JSON files using a unique URL, but cannot modify any JSON content. Below is a list of URL examples for items and monsters in the osrsbox-db database:
|
||||
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json/2.json`](https://www.osrsbox.com/osrsbox-db/items-json/2.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json/74.json`](https://www.osrsbox.com/osrsbox-db/items-json/74.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json/35.json`](https://www.osrsbox.com/osrsbox-db/items-json/35.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json/415.json`](https://www.osrsbox.com/osrsbox-db/items-json/415.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json/239.json`](https://www.osrsbox.com/osrsbox-db/items-json/239.json)
|
||||
|
||||
As displayed by the links above, each item or monster is stored in the `osrsbox-db` repository, under the [`items-json`](https://github.com/osrsbox/osrsbox-db/tree/master/docs/items-json) folder or [`monsters-json`](https://github.com/osrsbox/osrsbox-db/tree/master/docs/monsters-json) folder. In addition to the single JSON files for each item, many other JSON files can be fetched. Some more examples are provided below:
|
||||
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-complete.json`](https://www.osrsbox.com/osrsbox-db/items-complete.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/monsters-complete.json`](https://www.osrsbox.com/osrsbox-db/monsters-complete.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-summary.json`](https://www.osrsbox.com/osrsbox-db/items-summary.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/items-json-slot/items-cape.json`](https://www.osrsbox.com/osrsbox-db/items-json-slot/items-cape.json)
|
||||
- [`https://www.osrsbox.com/osrsbox-db/prayer-json/protect-from-magic.json`](https://www.osrsbox.com/osrsbox-db/prayer-json/protect-from-magic.json)
|
||||
|
||||
So how can you get and use these JSON files about OSRS items? It is pretty easy but depends on what you are trying to accomplish and what programming language you are using. Some examples are provided in the following subsections.
|
||||
|
||||
### Accessing the JSON API using Command Line Tools
|
||||
|
||||
Take a simple example of downloading a single JSON file. In a Linux system, we could use the `wget` command to download a single JSON file, as illustrated in the example code below:
|
||||
|
||||
```
|
||||
wget https://www.osrsbox.com/osrsbox-db/items-json/12453.json
|
||||
```
|
||||
|
||||
You could perform a similar technique using the `curl` tool:
|
||||
|
||||
```
|
||||
curl https://www.osrsbox.com/osrsbox-db/items-json/12453.json
|
||||
```
|
||||
|
||||
For Windows users, you could use PowerShell:
|
||||
|
||||
```
|
||||
Invoke-WebRequest -Uri "https://www.osrsbox.com/osrsbox-db/items-json/12453.json" -OutFile "12453.json"
|
||||
```
|
||||
|
||||
### Accessing the JSON API using Python
|
||||
|
||||
Maybe you are interested in downloading a single (or potentially multiple) JSON files about OSRS items and processing the information in a Python program. The short script below downloads the `12453.json` file using Python's `urllib` library, loads the data as a JSON object and prints the contents to the console. The code is a little messy, primarily due to supporting both Python 2 and 3 - as you can see from the `try` and `except` importing method implemented.
|
||||
|
||||
```
|
||||
import json
|
||||
|
||||
try:
|
||||
from urllib.request import urlopen
|
||||
except ImportError:
|
||||
from urllib2 import urlopen
|
||||
|
||||
url = ("https://www.osrsbox.com/osrsbox-db/items-json/12453.json")
|
||||
response = urlopen(url)
|
||||
data = response.read().decode("utf-8")
|
||||
json_obj = json.loads(data)
|
||||
print(json_obj)
|
||||
```
|
||||
|
||||
### Accessing the JSON API using JavaScript
|
||||
|
||||
Finally, let's have a look at JavaScript (specifically jQuery) example to fetch a JSON file from the osrsbox-db and build an HTML element to display in a web page. The example below is a very simple method to download the JSON file using the jQuery `getJSON` function. Once we get the JSON file, we loop through the JSON entries and print each key and value (e.g., `name` and _Black wizard hat (g)_) on its own line in a `div` element.
|
||||
|
||||
```
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
|
||||
<script>
|
||||
$(document).ready(function(){
|
||||
$("button").click(function(){
|
||||
$.getJSON("https://www.osrsbox.com/osrsbox-db/items-json/12453.json", function(result){
|
||||
$.each(result, function(i, field){
|
||||
$("div").append(i + " " + field + "<br>");
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<button>Get JSON data</button>
|
||||
<div></div>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
## The `osrsbox-db` GitHub Repository
|
||||
|
||||
The [official osrsbox-db GitHub repository](https://github.com/osrsbox/osrsbox-db) hosts the source code for the entire osrsbox-db project. The Python PyPi package is located in the `osrsbox` folder of the official development repository, while the other folders in this repository are used to store essential data and Python modules to build the item database.
|
||||
|
||||
### Using the Development Repository
|
||||
|
||||
If using this repository (the development version), you will need to fulfill some specific requirements. This includes having the following tools available on your system:
|
||||
|
||||
- Python 3.6 or above
|
||||
- Pip - the standard package manager for Python
|
||||
- A selection of additional Python packages
|
||||
|
||||
As a short example, I configured my Ubuntu 18.04 system to run the development repository code using the following steps:
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
sudo apt install python3-pip
|
||||
```
|
||||
|
||||
These two commands will install the `pip3` command, allowing the installation of Python packages. Then you can use `pip3` to install additional packages. The development repository requires a variety of Python packages in addition to the mandatory `dataclasses` package. These package requirements are documented in the [`requirements.txt`](https://github.com/osrsbox/osrsbox-db/tree/master/requirements.txt) file. It is recommended to use the `venv` module to set up your environment, then install the specified requirements. As an example, the following workflow is provided for Linux-based environments (make sure `python3` is available first):
|
||||
|
||||
```
|
||||
git clone --recursive https://github.com/osrsbox/osrsbox-db.git
|
||||
cd osrsbox-db
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
When you have finished with working in the `osrsbox-db` repository, make sure to deactivate the current `venv` environment using:
|
||||
|
||||
```
|
||||
deactivate
|
||||
```
|
||||
|
||||
### Summary of Repository Structure
|
||||
|
||||
- `builders`: The builders are the code that performs automatic regeneration of the databases. These builders read in a variety of data and produce a JSON file for each item or monster.
|
||||
- `items`: The item database builder that uses a collection of Python scripts to build the item database. The `builder.py` script is the primary entry point, and the `build_item.py` module does the processing of each item.
|
||||
- `monsters`: The monster database builder that uses a collection of Python scripts to build the monster database. The `builder.py` script is the primary entry point, and the `build_monster.py` module does the processing of each monster. Additionally, the `drop_table.py` module contains a selection of hard-coded drop tables for the various OSRS Wiki drop table templates such as the rare, herb, seed, gem and catacombs drop tables.
|
||||
- `data`: Collection of useful data files used in the osrsbox-db project.
|
||||
- `cache`: OSRS client cache dump (not present in repository due to size, but populated using the `scripts/cache` scripts).
|
||||
- `icons`: Item and prayer icons in base64.
|
||||
- `items`: Data used for item database generation.
|
||||
- `monsters`: Data used for monster database generation.
|
||||
- `schemas`: JSON schemas for the item and monster database, as well as schemas for item, npc and object definitions from cache data.
|
||||
- `wiki`: OSRS Wiki data dump including all item and monster page titles and page data.
|
||||
- `docs`: The publicly accessible item database available through this repo or by using the static JSON API. This folder contains the actual item database that is publicly available, or browsable within this repository (see section above for more information).
|
||||
- `osrsbox`: The Python PyPi package:
|
||||
- `items_api`: The Python API for interacting with the items database. The API has modules to load all items in the database, iterate through items, and access the different item properties.
|
||||
- `items_api_examples`: A collection of simple Python scripts that use the `items_api` to provide an example of what can be achieved and how to use the items database.
|
||||
- `monsters_api`: The Python API for interacting with the monster database. The API has modules to load all monsters in the database, iterate through items, and access different monster properties.
|
||||
- `monsters_api_examples`: A collection of simple Python scripts that use the `monsters_api` to provide an example of what can be achieved and how to use the monster's database.
|
||||
- `scripts`: A collection of scripts (using Python and BASH) to help automate common tasks including dumping the OSRS cache, scraping the OSRS wiki, generating schemas, updating the databases, and inserting data into a MongoDB database.
|
||||
- `cache`: A collection of scripts to extract useful data from the OSRS cache item, npc and object definition files.
|
||||
- `icons`: Various scripts to help process, check or update item icons.
|
||||
- `items`: A collection of scripts to help process data for the item builder.
|
||||
- `monsters`: A collection of scripts to help process data for the monster builder.
|
||||
- `update`: A collection of scripts for automating the data collection and database regeneration.
|
||||
- `wiki`: A collection of scripts for automating data extraction from the OSRS Wiki using the MediaWiki API.
|
||||
- `test`: A collection of PyTest tests.
|
||||
|
||||
### Item, Monster and Prayer Database Schemas
|
||||
|
||||
Technically, the `osrsbox-db` is not really a database - more specifically it should be called a data set. Anyway... the contents in the item/monster/prayer database need to adhere to a specified structure, as well as specified data types for each property. This is achieved (documented and tested) using the [Cerberus project](https://docs.python-cerberus.org/en/stable/). The Cerberus schema is useful to determine the properties that are available for each entity, and the types and requirements for each property, including:
|
||||
|
||||
- `type`: Specifies the data type (e.g., boolean, integer, string)
|
||||
- `required`: If the property must be populated (true or false)
|
||||
- `nullable`: If the property can be set to `null` or `None`
|
||||
|
||||
The Cerberus schemas are provided in a dedicated repository called [`osrsbox/schemas`](https://github.com/osrsbox/schemas), and implorted into this project as a submodule - this is because the schemas are used in other repositories and central management is required. The schemas are loaded into the `data/schemas` folder and includes:
|
||||
|
||||
1. [`schema-items.json`](https://github.com/osrsbox/schemas/blob/master/schema-items.json): This file defines the item schema, the defined properties, the property types, and some additional specifications including regex validation, and/or property type specification.
|
||||
1. [`schema-monsters.json`](https://github.com/osrsbox/schemas/blob/master/schema-monsters.json): This file defines the monster schema, the defined properties, the property types, and some additional specifications including regex validation, and/or property type specification.
|
||||
1. [`schema-prayers.json`](https://github.com/osrsbox/schemas/blob/master/schema-prayers.json): This file defines the prayer schema, the defined properties, the property types, and some additional specifications including regex validation, and/or property type specification.
|
||||
|
||||
All Cerberus schema files are authored using Cerberus version 1.3.2. This project uses the [`Cerberus` PyPi package](https://pypi.org/project/Cerberus/).
|
||||
|
||||
## The Item Database
|
||||
|
||||
Each item is represented by Python objects when using the PyPi `osrsbox` package, specifically using Python dataclass objects. Additionally, the data is accessible directly by parsing the raw JSON files. There are three types of objects, or classifications of data, that can be used to represent part of an in-game OSRS item, each outlined in the following subsections.
|
||||
|
||||
### Item Properties
|
||||
|
||||
An `ItemProperties` object type includes basic item metadata such as `id`, `name`, `examine` text, store `cost`, `highalch` and `lowalch` values and `quest_item` association. Every item object in the item database has all of these properties. If you are parsing the raw JSON files all of these properties are in the root of the JSON document - so they are not nested. All of the properties available are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| id | integer | Unique OSRS item ID number. | True | False |
|
||||
| name | string | The name of the item. | True | False |
|
||||
| last_updated | string | The last time (UTC) the item was updated (in ISO8601 date format). | True | False |
|
||||
| incomplete | boolean | If the item has incomplete wiki data. | True | False |
|
||||
| members | boolean | If the item is a members-only. | True | False |
|
||||
| tradeable | boolean | If the item is tradeable (between players and on the GE). | True | False |
|
||||
| tradeable_on_ge | boolean | If the item is tradeable (only on GE). | True | False |
|
||||
| stackable | boolean | If the item is stackable (in inventory). | True | False |
|
||||
| stacked | integer | If the item is stacked, indicated by the stack count. | True | True |
|
||||
| noted | boolean | If the item is noted. | True | False |
|
||||
| noteable | boolean | If the item is noteable. | True | False |
|
||||
| linked_id_item | integer | The linked ID of the actual item (if noted/placeholder). | True | True |
|
||||
| linked_id_noted | integer | The linked ID of an item in noted form. | True | True |
|
||||
| linked_id_placeholder | integer | The linked ID of an item in placeholder form. | True | True |
|
||||
| placeholder | boolean | If the item is a placeholder. | True | False |
|
||||
| equipable | boolean | If the item is equipable (based on right-click menu entry). | True | False |
|
||||
| equipable_by_player | boolean | If the item is equipable in-game by a player. | True | False |
|
||||
| equipable_weapon | boolean | If the item is an equipable weapon. | True | False |
|
||||
| cost | integer | The store price of an item. | True | False |
|
||||
| lowalch | integer | The low alchemy value of the item (cost * 0.4). | True | True |
|
||||
| highalch | integer | The high alchemy value of the item (cost * 0.6). | True | True |
|
||||
| weight | float | The weight (in kilograms) of the item. | True | True |
|
||||
| buy_limit | integer | The Grand Exchange buy limit of the item. | True | True |
|
||||
| quest_item | boolean | If the item is associated with a quest. | True | False |
|
||||
| release_date | string | Date the item was released (in ISO8601 format). | True | True |
|
||||
| duplicate | boolean | If the item is a duplicate. | True | False |
|
||||
| examine | string | The examine text for the item. | True | True |
|
||||
| icon | string | The item icon (in base64 encoding). | True | False |
|
||||
| wiki_name | string | The OSRS Wiki name for the item. | True | True |
|
||||
| wiki_url | string | The OSRS Wiki URL (possibly including anchor link). | True | True |
|
||||
| equipment | dict | The equipment bonuses of equipable armour/weapons. | True | True |
|
||||
| weapon | dict | The weapon bonuses including attack speed, type and stance. | True | True |
|
||||
|
||||
### Item Equipment
|
||||
|
||||
Many items in OSRS are equipable, this includes armor, weapons, and other _wearable_ items. Any equipable item has additional properties stored as an `ItemEquipment` object type - including attributes such as `attack_slash`, `defence_crush` and `melee_strength` values. The `ItemEquipment` object is nested within an `ItemProperties`. If you are parsing the raw JSON files, this data is nested under the `equipment` key. It is very important to note that not all items in OSRS are equipable. Only items with the `equipable_by_player` property set to `true` are equipable. The `equipable` property is similar, but this is the raw data extracted from the game cache - and can sometimes be incorrect (not equipable by a player). All of the properties available for equipable items are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| attack_stab | integer | The attack stab bonus of the item. | True | False |
|
||||
| attack_slash | integer | The attack slash bonus of the item. | True | False |
|
||||
| attack_crush | integer | The attack crush bonus of the item. | True | False |
|
||||
| attack_magic | integer | The attack magic bonus of the item. | True | False |
|
||||
| attack_ranged | integer | The attack ranged bonus of the item. | True | False |
|
||||
| defence_stab | integer | The defence stab bonus of the item. | True | False |
|
||||
| defence_slash | integer | The defence slash bonus of the item. | True | False |
|
||||
| defence_crush | integer | The defence crush bonus of the item. | True | False |
|
||||
| defence_magic | integer | The defence magic bonus of the item. | True | False |
|
||||
| defence_ranged | integer | The defence ranged bonus of the item. | True | False |
|
||||
| melee_strength | integer | The melee strength bonus of the item. | True | False |
|
||||
| ranged_strength | integer | The ranged strength bonus of the item. | True | False |
|
||||
| magic_damage | integer | The magic damage bonus of the item. | True | False |
|
||||
| prayer | integer | The prayer bonus of the item. | True | False |
|
||||
| slot | string | The equipment slot associated with the item (e.g., head). | True | False |
|
||||
| requirements | dict | An object of requirements {skill: level}. | True | True |
|
||||
|
||||
### Item Weapon
|
||||
|
||||
A select number of items in OSRS are equipable weapons. Any equipable item that is a weapon has additional properties stored as an `ItemWeapon` type object including attributes such as `attack_speed` and `weapon_types` values. Additionally, each weapon has an array of combat stances associated with it to determine the `combat_style`, `attack_type`, `attack_style` and any `bonuses` or combat `experience` association. The `ItemWeapon` object is nested within an `ItemProperties` object when using the Python API. If you are parsing the raw JSON files, this data is nested under the `weapon` key. It is very important to note that not all items in OSRS are equipable weapons. Only items with the `equipable_weapon` property set to `true` are equipable. All of the properties available for equipable weapons are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| attack_speed | integer | The attack speed of a weapon (in game ticks). | True | False |
|
||||
| weapon_type | string | The weapon classification (e.g., axes) | True | False |
|
||||
| stances | list | An array of weapon stance information. | True | False |
|
||||
|
||||
### Item: Python Object Example
|
||||
|
||||
A description of the properties that each item in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of an item as loaded in a Python object, specifically the _Abyssal whip_ item. Since this item is a type of equipment, there is an `EquipmentProperties` object nested with combat bonuses. Additionally, this item is also a weapon, so there is a `WeaponProperties` object with extra information. If the item was not equipable, the `EquipmentProperties` property would be `None` and the `equipable_by_player` would be `False`. If the item was not a weapon, the `WeaponProperties` key would be `None` and the `equipable_weapon` would be `False`.
|
||||
|
||||
```
|
||||
ItemProperties(
|
||||
id=4151,
|
||||
name='Abyssal whip',
|
||||
last_updated='2020-12-27',
|
||||
incomplete=False,
|
||||
members=True,
|
||||
tradeable=True,
|
||||
tradeable_on_ge=True,
|
||||
stackable=False,
|
||||
stacked=None,
|
||||
noted=False,
|
||||
noteable=True,
|
||||
linked_id_item=None,
|
||||
linked_id_noted=4152,
|
||||
linked_id_placeholder=14032,
|
||||
placeholder=False,
|
||||
equipable=True,
|
||||
equipable_by_player=True,
|
||||
equipable_weapon=True,
|
||||
cost=120001,
|
||||
lowalch=48000,
|
||||
highalch=72000,
|
||||
weight=0.453,
|
||||
buy_limit=70,
|
||||
quest_item=False,
|
||||
release_date='2005-01-26',
|
||||
duplicate=False,
|
||||
examine='A weapon from the abyss.',
|
||||
icon='iVBORw0KGgoAAAANSUhEUgAAACQAAAAgCAYAAAB6kdqOAAABvUlEQVR4Xu2Xv26DMBDG4QEyZECKIkVCKIoyVR26dOrQpUOHDn3/V3F7nL7689kGAo6z9JNuiH1wP+6PIU3zr2Jq3bRVkQ/Y7feBvfcn93o8upfDwT11XQKwOGQMwfYx9O7rcnaf52GEezuFgNdfn4JQ7RjAQojZLAAMcPJbAOH73PcloBTIQiEAG8MB7Pt6MQ+wSW1QAs6Kh1A/NgtnHyKMcZMUCP3AIBw0XcqmgU9qb4W0JwTIwuRAYHETF4FSIMkORjn1xCnjayy8lN/vLVY7TglfvBRGTJpZrpXM+my1f6DhPRdJs8M3nAPibGDseY9hVgHxzbh3chC22dkPQ8EnufddpBgI69Lk3B8hnPrwOsPEw7FYqUzoOsqBUtps8XUASh0bYbxZxUCcJZzCNnjOBGgDDBRD8d4tQAVgRAqEs2jusLOGEhaCgTQTgApLp/s5A0RBGMg3shx2YZb0fZUz9issD4VpsR4PkJ+uYbczJQr94rW7KT3yDJcegLtqeuRlAFa+0bdoeuTxPV2538Ixt1D86Vutr8IR16CSndzfoSpQLIDh09dmscL5lJICMUClw3JKD8tGXiVgfgACr1tEhnw7UAAAAABJRU5ErkJggg==',
|
||||
wiki_name='Abyssal whip',
|
||||
wiki_url='https://oldschool.runescape.wiki/w/Abyssal_whip',
|
||||
equipment=ItemEquipment(
|
||||
attack_stab=0,
|
||||
attack_slash=82,
|
||||
attack_crush=0,
|
||||
attack_magic=0,
|
||||
attack_ranged=0,
|
||||
defence_stab=0,
|
||||
defence_slash=0,
|
||||
defence_crush=0,
|
||||
defence_magic=0,
|
||||
defence_ranged=0,
|
||||
melee_strength=82,
|
||||
ranged_strength=0,
|
||||
magic_damage=0,
|
||||
prayer=0,
|
||||
slot='weapon',
|
||||
requirements={'attack': 70}
|
||||
),
|
||||
weapon=ItemWeapon(
|
||||
attack_speed=4,
|
||||
weapon_type='whip',
|
||||
stances=[
|
||||
{
|
||||
'combat_style': 'flick',
|
||||
'attack_type': 'slash',
|
||||
'attack_style': 'accurate',
|
||||
'experience': 'attack',
|
||||
'boosts': None
|
||||
},
|
||||
{
|
||||
'combat_style': 'lash',
|
||||
'attack_type': 'slash',
|
||||
'attack_style': 'controlled',
|
||||
'experience': 'shared',
|
||||
'boosts': None},
|
||||
{
|
||||
'combat_style': 'deflect',
|
||||
'attack_type': 'slash',
|
||||
'attack_style': 'defensive',
|
||||
'experience': 'defence',
|
||||
'boosts': None
|
||||
}
|
||||
]
|
||||
)
|
||||
)
|
||||
```
|
||||
|
||||
### Item: JSON Example
|
||||
|
||||
A description of the properties that each item in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of an item, specifically the _Abyssal whip_ item. Since this item is a type of equipment, there is an `equipment` key with combat bonuses. Additionally, this item is also a weapon, so there is a `weapon` key with extra information. If the item was not equipable, the `equipment` key would be `null` and the `equipable_by_player` would be `false`. If the item was not a weapon, the `weapon` key would be `null` and the `equipable_weapon` would be `false`.
|
||||
|
||||
```
|
||||
{
|
||||
"id": 4151,
|
||||
"name": "Abyssal whip",
|
||||
"last_updated": "2020-12-27",
|
||||
"incomplete": false,
|
||||
"members": true,
|
||||
"tradeable": true,
|
||||
"tradeable_on_ge": true,
|
||||
"stackable": false,
|
||||
"stacked": null,
|
||||
"noted": false,
|
||||
"noteable": true,
|
||||
"linked_id_item": null,
|
||||
"linked_id_noted": 4152,
|
||||
"linked_id_placeholder": 14032,
|
||||
"placeholder": false,
|
||||
"equipable": true,
|
||||
"equipable_by_player": true,
|
||||
"equipable_weapon": true,
|
||||
"cost": 120001,
|
||||
"lowalch": 48000,
|
||||
"highalch": 72000,
|
||||
"weight": 0.453,
|
||||
"buy_limit": 70,
|
||||
"quest_item": false,
|
||||
"release_date": "2005-01-26",
|
||||
"duplicate": false,
|
||||
"examine": "A weapon from the abyss.",
|
||||
"icon": "iVBORw0KGgoAAAANSUhEUgAAACQAAAAgCAYAAAB6kdqOAAABvUlEQVR4Xu2Xv26DMBDG4QEyZECKIkVCKIoyVR26dOrQpUOHDn3/V3F7nL7689kGAo6z9JNuiH1wP+6PIU3zr2Jq3bRVkQ/Y7feBvfcn93o8upfDwT11XQKwOGQMwfYx9O7rcnaf52GEezuFgNdfn4JQ7RjAQojZLAAMcPJbAOH73PcloBTIQiEAG8MB7Pt6MQ+wSW1QAs6Kh1A/NgtnHyKMcZMUCP3AIBw0XcqmgU9qb4W0JwTIwuRAYHETF4FSIMkORjn1xCnjayy8lN/vLVY7TglfvBRGTJpZrpXM+my1f6DhPRdJs8M3nAPibGDseY9hVgHxzbh3chC22dkPQ8EnufddpBgI69Lk3B8hnPrwOsPEw7FYqUzoOsqBUtps8XUASh0bYbxZxUCcJZzCNnjOBGgDDBRD8d4tQAVgRAqEs2jusLOGEhaCgTQTgApLp/s5A0RBGMg3shx2YZb0fZUz9issD4VpsR4PkJ+uYbczJQr94rW7KT3yDJcegLtqeuRlAFa+0bdoeuTxPV2538Ixt1D86Vutr8IR16CSndzfoSpQLIDh09dmscL5lJICMUClw3JKD8tGXiVgfgACr1tEhnw7UAAAAABJRU5ErkJggg==",
|
||||
"wiki_name": "Abyssal whip",
|
||||
"wiki_url": "https://oldschool.runescape.wiki/w/Abyssal_whip",
|
||||
"equipment": {
|
||||
"attack_stab": 0,
|
||||
"attack_slash": 82,
|
||||
"attack_crush": 0,
|
||||
"attack_magic": 0,
|
||||
"attack_ranged": 0,
|
||||
"defence_stab": 0,
|
||||
"defence_slash": 0,
|
||||
"defence_crush": 0,
|
||||
"defence_magic": 0,
|
||||
"defence_ranged": 0,
|
||||
"melee_strength": 82,
|
||||
"ranged_strength": 0,
|
||||
"magic_damage": 0,
|
||||
"prayer": 0,
|
||||
"slot": "weapon",
|
||||
"requirements": {
|
||||
"attack": 70
|
||||
}
|
||||
},
|
||||
"weapon": {
|
||||
"attack_speed": 4,
|
||||
"weapon_type": "whip",
|
||||
"stances": [
|
||||
{
|
||||
"combat_style": "flick",
|
||||
"attack_type": "slash",
|
||||
"attack_style": "accurate",
|
||||
"experience": "attack",
|
||||
"boosts": null
|
||||
},
|
||||
{
|
||||
"combat_style": "lash",
|
||||
"attack_type": "slash",
|
||||
"attack_style": "controlled",
|
||||
"experience": "shared",
|
||||
"boosts": null
|
||||
},
|
||||
{
|
||||
"combat_style": "deflect",
|
||||
"attack_type": "slash",
|
||||
"attack_style": "defensive",
|
||||
"experience": "defence",
|
||||
"boosts": null
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## The Monster Database
|
||||
|
||||
Each monster is represented by Python objects when using the PyPi `osrsbox` package, specifically using Python dataclass objects. Additionally, the data is accessible directly by parsing the raw JSON files. There are two types of objects, or classifications of data, that can be used to represent part of an in-game OSRS monster, each outlined in the following subsections.
|
||||
|
||||
### Monster Properties
|
||||
|
||||
A `MonsterProperties` object type includes basic monster metadata such as `id`, `name`, `examine` text, `combat_level`, `attack_speed` and `hitpoints` values and slayer association such as `slayer_masters` who give this monster as a task. Every monster object in the monster database has all of these properties. If you are parsing the raw JSON files all of these properties are in the root of the JSON document - so they are not nested. All of the properties available are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| id | integer | Unique OSRS monster ID number. | True | False |
|
||||
| name | string | The name of the monster. | True | False |
|
||||
| last_updated | string | The last time (UTC) the monster was updated (in ISO8601 date format). | True | True |
|
||||
| incomplete | boolean | If the monster has incomplete wiki data. | True | False |
|
||||
| members | boolean | If the monster is members only, or not. | True | False |
|
||||
| release_date | string | The release date of the monster (in ISO8601 date format). | True | True |
|
||||
| combat_level | integer | The combat level of the monster. | True | False |
|
||||
| size | integer | The size, in tiles, of the monster. | True | False |
|
||||
| hitpoints | integer | The number of hitpoints a monster has. | True | True |
|
||||
| max_hit | integer | The maximum hit of the monster. | True | True |
|
||||
| attack_type | list | The attack style (e.g., melee, magic, range) of the monster. | True | False |
|
||||
| attack_speed | integer | The attack speed (in game ticks) of the monster. | True | True |
|
||||
| aggressive | boolean | If the monster is aggressive, or not. | True | False |
|
||||
| poisonous | boolean | If the monster poisons, or not | True | False |
|
||||
| venomous | boolean | If the monster poisons using venom, or not | True | False |
|
||||
| immune_poison | boolean | If the monster is immune to poison, or not | True | False |
|
||||
| immune_venom | boolean | If the monster is immune to venom, or not | True | False |
|
||||
| attributes | list | An array of monster attributes. | True | False |
|
||||
| category | list | An array of monster category. | True | False |
|
||||
| slayer_monster | boolean | If the monster is a potential slayer task. | True | False |
|
||||
| slayer_level | integer | The slayer level required to kill the monster. | True | True |
|
||||
| slayer_xp | float | The slayer XP rewarded for a monster kill. | True | True |
|
||||
| slayer_masters | list | The slayer masters who can assign the monster. | True | False |
|
||||
| duplicate | boolean | If the monster is a duplicate. | True | False |
|
||||
| examine | string | The examine text of the monster. | True | False |
|
||||
| wiki_name | string | The OSRS Wiki name for the monster. | True | False |
|
||||
| wiki_url | string | The OSRS Wiki URL (possibly including anchor link). | True | False |
|
||||
| attack_level | integer | The attack level of the monster. | True | False |
|
||||
| strength_level | integer | The strength level of the monster. | True | False |
|
||||
| defence_level | integer | The defence level of the monster. | True | False |
|
||||
| magic_level | integer | The magic level of the monster. | True | False |
|
||||
| ranged_level | integer | The ranged level of the monster. | True | False |
|
||||
| attack_bonus | integer | The attack bonus of the monster. | True | False |
|
||||
| strength_bonus | integer | The strength bonus of the monster. | True | False |
|
||||
| attack_magic | integer | The magic attack of the monster. | True | False |
|
||||
| magic_bonus | integer | The magic bonus of the monster. | True | False |
|
||||
| attack_ranged | integer | The ranged attack of the monster. | True | False |
|
||||
| ranged_bonus | integer | The ranged bonus of the monster. | True | False |
|
||||
| defence_stab | integer | The defence stab bonus of the monster. | True | False |
|
||||
| defence_slash | integer | The defence slash bonus of the monster. | True | False |
|
||||
| defence_crush | integer | The defence crush bonus of the monster. | True | False |
|
||||
| defence_magic | integer | The defence magic bonus of the monster. | True | False |
|
||||
| defence_ranged | integer | The defence ranged bonus of the monster. | True | False |
|
||||
| drops | list | An array of monster drop objects. | True | False |
|
||||
|
||||
### Monster Drops
|
||||
|
||||
Most monsters in OSRS drop items when they have been defeated (killed). All monster drops are stored in the `drops` property in an array containing properties about the item drop. When using the PyPi `osrsbox` package, these drops are represented by a list of `MonsterDrops` object type. When parsing the raw JSON files, the drops are stored in an array, that are nested under the `drops` key. The data included with the monster drops are the item `id`, item `name`, the drop `rarity`, whether the drop is `noted` and any `drop_requirements`. All of the properties available for item drops are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| id | integer | The ID number of the item drop. | True | False |
|
||||
| name | string | The name of the item drop. | True | False |
|
||||
| members | boolean | If the drop is a members-only item. | True | False |
|
||||
| quantity | string | The quantity of the item drop (integer, comma-separated or range). | True | True |
|
||||
| noted | boolean | If the item drop is noted, or not. | True | False |
|
||||
| rarity | float | The rarity of the item drop (as a float out of 1.0). | True | False |
|
||||
| rolls | integer | Number of rolls from the drop. | True | False |
|
||||
|
||||
### Monster: Python Object Example
|
||||
|
||||
A description of the properties that each monster in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of a monster, specifically the _Abyssal demon_ monster. Please note that the number of item `drops` key data has been reduced to make the data more readable.
|
||||
|
||||
```
|
||||
MonsterProperties(
|
||||
id=415,
|
||||
name='Abyssal demon',
|
||||
last_updated='2020-12-25',
|
||||
incomplete=False,
|
||||
members=True,
|
||||
release_date='2005-01-26',
|
||||
combat_level=124,
|
||||
size=1,
|
||||
hitpoints=150,
|
||||
max_hit=8,
|
||||
attack_type=['stab'],
|
||||
attack_speed=4,
|
||||
aggressive=False,
|
||||
poisonous=False,
|
||||
venomous=False,
|
||||
immune_poison=False,
|
||||
immune_venom=False,
|
||||
attributes=['demon'],
|
||||
category=['abyssal demon'],
|
||||
slayer_monster=True,
|
||||
slayer_level=85,
|
||||
slayer_xp=150.0,
|
||||
slayer_masters=[
|
||||
'vannaka',
|
||||
'chaeldar',
|
||||
'konar',
|
||||
'nieve',
|
||||
'duradel'
|
||||
],
|
||||
duplicate=False,
|
||||
examine='A denizen of the Abyss!',
|
||||
wiki_name='Abyssal demon (Standard)',
|
||||
wiki_url='https://oldschool.runescape.wiki/w/Abyssal_demon#Standard',
|
||||
attack_level=97,
|
||||
strength_level=67,
|
||||
defence_level=135,
|
||||
magic_level=1,
|
||||
ranged_level=1,
|
||||
attack_bonus=0,
|
||||
strength_bonus=0,
|
||||
attack_magic=0,
|
||||
magic_bonus=0,
|
||||
attack_ranged=0,
|
||||
ranged_bonus=0,
|
||||
defence_stab=20,
|
||||
defence_slash=20,
|
||||
defence_crush=20,
|
||||
defence_magic=0,
|
||||
defence_ranged=20,
|
||||
drops=
|
||||
[
|
||||
MonsterDrop(
|
||||
id=592,
|
||||
name='Ashes',
|
||||
members=False,
|
||||
quantity='1',
|
||||
noted=False,
|
||||
rarity=1.0,
|
||||
rolls=1
|
||||
),
|
||||
...
|
||||
MonsterDrop(
|
||||
id=4151,
|
||||
name='Abyssal whip',
|
||||
members=True,
|
||||
quantity='1',
|
||||
noted=False,
|
||||
rarity=0.001953125,
|
||||
rolls=1
|
||||
)
|
||||
]
|
||||
)
|
||||
```
|
||||
|
||||
### Monster: JSON Example
|
||||
|
||||
A description of the properties that each monster in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of a monster, specifically the _Abyssal demon_ monster. Please note that the number of item `drops` key data has been reduced to make the data more readable.
|
||||
|
||||
```
|
||||
{
|
||||
"id": 415,
|
||||
"name": "Abyssal demon",
|
||||
"last_updated": "2020-12-25",
|
||||
"incomplete": false,
|
||||
"members": true,
|
||||
"release_date": "2005-01-26",
|
||||
"combat_level": 124,
|
||||
"size": 1,
|
||||
"hitpoints": 150,
|
||||
"max_hit": 8,
|
||||
"attack_type": [
|
||||
"stab"
|
||||
],
|
||||
"attack_speed": 4,
|
||||
"aggressive": false,
|
||||
"poisonous": false,
|
||||
"venomous": false,
|
||||
"immune_poison": false,
|
||||
"immune_venom": false,
|
||||
"attributes": [
|
||||
"demon"
|
||||
],
|
||||
"category": [
|
||||
"abyssal demon"
|
||||
],
|
||||
"slayer_monster": true,
|
||||
"slayer_level": 85,
|
||||
"slayer_xp": 150.0,
|
||||
"slayer_masters": [
|
||||
"vannaka",
|
||||
"chaeldar",
|
||||
"konar",
|
||||
"nieve",
|
||||
"duradel"
|
||||
],
|
||||
"duplicate": false,
|
||||
"examine": "A denizen of the Abyss!",
|
||||
"wiki_name": "Abyssal demon (Standard)",
|
||||
"wiki_url": "https://oldschool.runescape.wiki/w/Abyssal_demon#Standard",
|
||||
"attack_level": 97,
|
||||
"strength_level": 67,
|
||||
"defence_level": 135,
|
||||
"magic_level": 1,
|
||||
"ranged_level": 1,
|
||||
"attack_bonus": 0,
|
||||
"strength_bonus": 0,
|
||||
"attack_magic": 0,
|
||||
"magic_bonus": 0,
|
||||
"attack_ranged": 0,
|
||||
"ranged_bonus": 0,
|
||||
"defence_stab": 20,
|
||||
"defence_slash": 20,
|
||||
"defence_crush": 20,
|
||||
"defence_magic": 0,
|
||||
"defence_ranged": 20,
|
||||
"drops": [
|
||||
{
|
||||
"id": 1623,
|
||||
"name": "Uncut sapphire",
|
||||
"members": true,
|
||||
"quantity": "1",
|
||||
"noted": false,
|
||||
"rarity": 0.009765625,
|
||||
"rolls": 1
|
||||
},
|
||||
...
|
||||
{
|
||||
"id": 4151,
|
||||
"name": "Abyssal whip",
|
||||
"members": true,
|
||||
"quantity": "1",
|
||||
"noted": false,
|
||||
"rarity": 0.001953125,
|
||||
"rolls": 1
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## The Prayer Database
|
||||
|
||||
Each prayer is represented by Python objects when using the PyPi `osrsbox` package, specifically using Python dataclass objects Additionally, the data is accessible directly by parsing the raw JSON files. All prayer data is stored in a single object to represent the properties of an in-game OSRS prayer, which is outlined in the following subsection.
|
||||
|
||||
### Prayer Properties
|
||||
|
||||
A `PrayerProperties` object type includes basic prayer metadata such as `id`, `name`, `description` text, `drain_per_minute`, `requirements` and `bonuses` values. Every prayer object in the prayer database has all of these properties. If you are parsing the raw JSON files all of these properties are in the root of the JSON document - so they are not nested. All of the properties available are listed in the table below including the property name, the data types used, a description of the property, if the property is required to be populated, and if the property is nullable (able to be set to `null` or `None`).
|
||||
|
||||
| Property | Data type | Description | Required | Nullable |
|
||||
| -------- | --------- | ----------- | -------- |----------|
|
||||
| id | integer | Unique prayer ID number. | True | False |
|
||||
| name | string | The name of the prayer. | True | False |
|
||||
| members | boolean | If the prayer is members-only. | True | False |
|
||||
| description | string | The prayer description (as show in-game). | True | False |
|
||||
| drain_per_minute | float | The prayer point drain rate per minute. | True | False |
|
||||
| wiki_url | string | The OSRS Wiki URL. | True | False |
|
||||
| requirements | dict | The stat requirements to use the prayer. | True | False |
|
||||
| bonuses | dict | The bonuses a prayer provides. | True | False |
|
||||
| icon | string | The prayer icon. | True | False |
|
||||
|
||||
### Prayer: Python Object Example
|
||||
|
||||
A description of the properties that each prayer in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of a prayer, specifically the _Rigour_ prayer, as loaded in the `osrsbox` PyPi Python package.
|
||||
|
||||
```
|
||||
PrayerProperties(
|
||||
id=28,
|
||||
name='Rigour',
|
||||
members=True,
|
||||
description='Increases your Ranged attack by 20% and damage by 23%, and your defence by 25%.',
|
||||
drain_per_minute=40.0,
|
||||
wiki_url='https://oldschool.runescape.wiki/w/Rigour',
|
||||
requirements={'prayer': 74, 'defence': 70},
|
||||
bonuses={'ranged': 20, 'ranged_strength': 25, 'defence': 23},
|
||||
icon='iVBORw0KGgoAAAANSUhEUgAAABwAAAAYCAYAAADpnJ2CAAABMklEQVR42rWW3Q0CIRCEjwJ8tgBrMPHZFmzAIny0gOvA+izAGjCYcMwNswucSrLJHT/7McvyM02bSojTfwo7Tv8h3h/PqKFfTSTEYqUuwTRQ9R8Erp0XdV79ANBWw7Y/7Mw2W7mhqDSGxTkC0vf5eqqg2I99CKAOVXZ0mY+Lw/SdgFjHk7DD3xE+hLZsINR2+BQMlXG7Gu8Cc2jyt4KketWWw22HWYTUWqcMsYzVcmIBMFQZqBSxmvl1+xj2Z7XdQByQHbKSDET1qNCB1uuHs1ZhY2NgQ2W9fpbCEaAT0jpLeZAKaQvmJI3OUs5QhHoZqoDuWcr7jDe4lURqL3bcIOsTxwJbxmvdcV0FeQPgPmydpZ3KJvcg904bVNi+GwegCPYgG2D1g6nXfvCu4cdRy9rlDXGzl98mKbMMAAAAAElFTkSuQmCC'
|
||||
)
|
||||
```
|
||||
|
||||
### Prayer: JSON Example
|
||||
|
||||
A description of the properties that each prayer in the database can have is useful, but sometimes it is simpler to provide an example. Below is a full example of a prayer, specifically the _Rigour_ prayer, as a JSON object.
|
||||
|
||||
```
|
||||
"id": 28,
|
||||
"name": "Rigour",
|
||||
"members": true,
|
||||
"description": "Increases your Ranged attack by 20% and damage by 23%, and your defence by 25%.",
|
||||
"drain_per_minute": 40.0,
|
||||
"wiki_url": "https://oldschool.runescape.wiki/w/Rigour",
|
||||
"requirements": {
|
||||
"prayer": 74,
|
||||
"defence": 70
|
||||
},
|
||||
"bonuses": {
|
||||
"ranged": 20,
|
||||
"ranged_strength": 25,
|
||||
"defence": 23
|
||||
},
|
||||
"icon": "iVBORw0KGgoAAAANSUhEUgAAABwAAAAYCAYAAADpnJ2CAAABMklEQVR42rWW3Q0CIRCEjwJ8tgBrMPHZFmzAIny0gOvA+izAGjCYcMwNswucSrLJHT/7McvyM02bSojTfwo7Tv8h3h/PqKFfTSTEYqUuwTRQ9R8Erp0XdV79ANBWw7Y/7Mw2W7mhqDSGxTkC0vf5eqqg2I99CKAOVXZ0mY+Lw/SdgFjHk7DD3xE+hLZsINR2+BQMlXG7Gu8Cc2jyt4KketWWw22HWYTUWqcMsYzVcmIBMFQZqBSxmvl1+xj2Z7XdQByQHbKSDET1qNCB1uuHs1ZhY2NgQ2W9fpbCEaAT0jpLeZAKaQvmJI3OUs5QhHoZqoDuWcr7jDe4lURqL3bcIOsTxwJbxmvdcV0FeQPgPmydpZ3KJvcg904bVNi+GwegCPYgG2D1g6nXfvCu4cdRy9rlDXGzl98mKbMMAAAAAElFTkSuQmCC"
|
||||
}
|
||||
```
|
||||
|
||||
## Project Contribution
|
||||
|
||||
This project would thoroughly benefit from contributions from additional developers. Please feel free to submit a pull request if you have code that you wish to contribute - I would thoroughly appreciate the helping hand. For any code contributions, the best method is to [open a new GitHub pull request](https://github.com/osrsbox/osrsbox-db/pulls) in the project repository. Also, feel free to contact me (e.g., on the Discord server) if you wish to discuss contribution before making a pull request. If you are not a software developer and want to contribute, even something as small as _Staring_ this repository really makes my day and keeps me motivated!
|
||||
|
||||
### Crowd Sourcing Item Skill Requirements
|
||||
|
||||
A really manual part of the item database is the `item.equipment.requirements` data. So far, I have manually populated this data... for over 3,500 items! To keep this project alive, I have stopped adding in this data (as it takes a lot of time). Here is a summary of how the item skill requirements work:
|
||||
|
||||
- All item requirements are stored in the [`skill-requirements.json`](https://github.com/osrsbox/osrsbox-db/blob/master/data/items/items-skill-requirements.json) file
|
||||
|
||||
- They have a structure of:
|
||||
|
||||
```
|
||||
"item_id": {
|
||||
"skill_name": integer
|
||||
},
|
||||
```
|
||||
|
||||
- For example, the Abyssal whip item:
|
||||
|
||||
```
|
||||
"4151": {
|
||||
"attack": 70
|
||||
},
|
||||
```
|
||||
|
||||
- For the `skill_name`, the [`schema-items.json`](https://github.com/osrsbox/schemas/blob/67b062b8d8499f80f43a95ff3b72cc40a6a833c9/schema-items.json#L293) file has a list of the allowed values - to help get the correct skill name. For example, `runecraft` and not `runecrafting`!
|
||||
|
||||
With some community help (by crowd sourcing) we could keep this data point fresh. If you find an error or want to add in a requirement, and want to contribute, here are the best ways to help:
|
||||
|
||||
- GitHub PR: Clone the project repo, make changes to `skill-requirements.json`, submit PR
|
||||
- GitHub Issue: Submit an issue with the fix. It would really help me if you put the request in the correct JSON format as described above!
|
||||
|
||||
FYI - there is currently no quest-associated requirements. This would be a great addition to the project, but seems to be a very complex thing to add.
|
||||
|
||||
## Additional Project Information
|
||||
|
||||
This section contains additional information about the osrsbox-db project. For detailed information about the project see the [`osrsbox.com`](https://www.osrsbox.com/) website for the official project page, and the _Database_ tag to find blog posts about the project:
|
||||
|
||||
- https://www.osrsbox.com/projects/osrsbox-db/
|
||||
- https://www.osrsbox.com/blog/tags/Database/
|
||||
|
||||
### Project Feedback
|
||||
|
||||
I would thoroughly appreciate any feedback regarding the osrsbox-db project, especially problems with the inaccuracies of the data provided. So if you notice any problem with the accuracy of item property data, could you please let me know. The same goes for any discovered bugs, or if you have a specific feature request. The best method is to [open a new Github issue](https://github.com/osrsbox/osrsbox-db/issues) in the project repository.
|
||||
|
||||
### Project License
|
||||
|
||||
The osrsbox-db project is released under the GNU General Public License version 3 as published by the Free Software Foundation. You can read the [LICENSE](LICENSE) file for the full license, check the [GNU GPL](https://www.gnu.org/licenses/gpl-3.0.en.html) page for additional information, or check the [tl;drLegal](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)) documentation for the license explained in simple English. The GPL license is specified for all source code contained in this project. Other content is specified under GPL if not listed in the **Exceptions to GPL** below.
|
||||
|
||||
#### Exceptions to GPL
|
||||
|
||||
Old School RuneScape (OSRS) content and materials are trademarks and copyrights of JaGeX or its licensors. All rights reserved. OSRSBox and the osrsbox-db project is not associated or affiliated with JaGeX or its licensors.
|
||||
|
||||
Additional data to help build this project is sourced from the [OSRS Wiki](https://oldschool.runescape.wiki/). This primarily includes item and monster metadata that is not available in the OSRS cache. As specified by the [Weird Gloop Copyright](https://meta.weirdgloop.org/w/Meta:Copyrights) page, this content is licensed under CC BY-NC-SA 3.0 - [Attribution-NonCommercial-ShareAlike 3.0 Unported](https://creativecommons.org/licenses/by-nc-sa/3.0/) license.
|
||||
|
||||
### Project Attribution
|
||||
|
||||
The osrsbox-db project is a labor of love. I put a huge amount of time and effort into the project, and I want people to use it. That is the entire reason for its existence. I am not too fussed about attribution guidelines... but if you want to use the project please adhere to the licenses used. Please feel free to link to this repository or my [OSRSBox website](https://www.osrsbox.com/) if you use it in your project - mainly so others can find it, and hopefully use it too!
|
||||
BIN
blank.png
Normal file
BIN
blank.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
686
builders/items/build_item.py
Normal file
686
builders/items/build_item.py
Normal file
|
|
@ -0,0 +1,686 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Build an item given OSRS cache, wiki and custom data.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from typing import Dict
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from datetime import timezone
|
||||
|
||||
import mwparserfromhell
|
||||
from deepdiff import DeepDiff
|
||||
|
||||
import config
|
||||
import validator
|
||||
from builders.items import infobox_cleaner
|
||||
from scripts.wiki.wikitext_parser import WikitextTemplateParser
|
||||
from osrsbox.items_api.item_properties import ItemProperties
|
||||
|
||||
|
||||
class BuildItem:
|
||||
def __init__(self, **kwargs):
|
||||
# ID number to process
|
||||
self.item_id = kwargs["item_id"]
|
||||
# Raw cache data for all items
|
||||
self.all_items_cache_data = kwargs["all_items_cache_data"]
|
||||
# All current item database contents
|
||||
self.all_db_items = kwargs["all_db_items"]
|
||||
# Raw data dump from OSRS Wiki
|
||||
self.all_wikitext_raw = kwargs["all_wikitext_raw"]
|
||||
# Processed wikitext for all items
|
||||
self.all_wikitext_processed = kwargs["all_wikitext_processed"]
|
||||
# Dictionary of unalchable items (using item name)
|
||||
self.unalchable = kwargs["unalchable"]
|
||||
# Dictionary of item buy limits
|
||||
self.buy_limits = kwargs["buy_limits"]
|
||||
# Dictionary of item requirements
|
||||
self.skill_requirements = kwargs["skill_requirements"]
|
||||
# Weapon stances dictionary
|
||||
self.weapon_stances = kwargs["weapon_stances"]
|
||||
# Dictionary of item icons
|
||||
self.icons = kwargs["icons"]
|
||||
# A dictionary of know duplicate items
|
||||
self.duplicates = kwargs["duplicates"]
|
||||
# The item schema
|
||||
self.schema_data = kwargs["schema_data"]
|
||||
# A list of already known (processed) items
|
||||
self.known_items = kwargs["known_items"]
|
||||
# Specify verbosity
|
||||
self.verbose = kwargs["verbose"]
|
||||
|
||||
# For this item instance, create dictionary for property storage
|
||||
self.item_dict = dict()
|
||||
|
||||
self.infobox_version_number = None
|
||||
self.item_wikitext = None
|
||||
self.wikitext_found_using = None
|
||||
|
||||
def preprocessing(self) -> Dict:
|
||||
"""Preprocess an item, and set important object variables.
|
||||
|
||||
This function preprocesses every item dumped from the OSRS cache. Various
|
||||
properties are set to help further processing. Items are determined if
|
||||
they are a linked item (noted/placeholder), or an actual item. The item
|
||||
is checked if it is a valid item (has a wiki page, is an actual item etc.).
|
||||
Finally, the wikitext (from the OSRS wiki) is found by looking up ID, linked
|
||||
ID, name, and normalized name. The `Infobox Item` or `Infobox Pet` is then
|
||||
extracted so that the wiki properties can be later processed and populated.
|
||||
|
||||
:return: A dictionary including success and code.
|
||||
"""
|
||||
# Initialize dictionary to return preprocessing status
|
||||
status = {
|
||||
"status": False,
|
||||
"code": None
|
||||
}
|
||||
|
||||
# Set item ID variables
|
||||
self.item_id_str = str(self.item_id)
|
||||
|
||||
# Load item dictionary of cache data based on item ID
|
||||
# This raw cache data is the baseline information about the specific item
|
||||
# and can be considered 100% correct and available for every item
|
||||
self.item_cache_data = self.all_items_cache_data[self.item_id_str]
|
||||
|
||||
# Set item name variable (directly from the cache dump)
|
||||
self.item_name = self.item_cache_data["name"]
|
||||
|
||||
if self.verbose:
|
||||
print(f">>> {self.item_id_str} {self.item_name}")
|
||||
|
||||
# Get the linked ID item value, if available
|
||||
self.linked_id_item_int = None
|
||||
self.linked_id_item_str = None
|
||||
if self.item_cache_data["linked_id_item"] is not None:
|
||||
self.linked_id_item_int = int(self.item_cache_data["linked_id_item"])
|
||||
self.linked_id_item_str = str(self.item_cache_data["linked_id_item"])
|
||||
|
||||
# Determine the ID number to extract
|
||||
# Noted and placeholder items should use the linked_id_item property
|
||||
# to fill in additional wiki data...
|
||||
item_id_to_process_int = None
|
||||
if self.item_cache_data["noted"] is True or self.item_cache_data["placeholder"] is True:
|
||||
item_id_to_process_int = int(self.linked_id_item_int)
|
||||
else:
|
||||
item_id_to_process_int = int(self.item_id)
|
||||
|
||||
# Find the wiki page
|
||||
has_infobox = False
|
||||
|
||||
# Try to find the wiki data using direct ID number search
|
||||
if self.all_wikitext_processed.get(self.item_id_str, None):
|
||||
self.item_wikitext = self.all_wikitext_processed.get(self.item_id_str, None)
|
||||
self.wikitext_found_using = "id"
|
||||
status["code"] = "lookup_passed_id"
|
||||
status["status"] = True
|
||||
|
||||
# Try to find the wiki data using linked_id_item ID number search
|
||||
elif self.all_wikitext_processed.get(self.linked_id_item_str, None):
|
||||
self.item_wikitext = self.all_wikitext_processed.get(self.linked_id_item_str, None)
|
||||
self.wikitext_found_using = "linked_id"
|
||||
status["code"] = "lookup_passed_linked_id"
|
||||
status["status"] = True
|
||||
|
||||
# Try to find the wiki data using direct name search
|
||||
elif self.all_wikitext_raw.get(self.item_name, None):
|
||||
self.item_wikitext = self.all_wikitext_raw.get(self.item_name, None)
|
||||
self.wikitext_found_using = "name"
|
||||
status["code"] = "lookup_passed_name"
|
||||
status["status"] = True
|
||||
|
||||
else:
|
||||
status["code"] = "no_item_wikitext"
|
||||
return status
|
||||
|
||||
# Parse the infobox item
|
||||
infobox_parser = WikitextTemplateParser(self.item_wikitext)
|
||||
|
||||
# Try extract infobox for item, then pet
|
||||
has_infobox = infobox_parser.extract_infobox("infobox item")
|
||||
if not has_infobox:
|
||||
has_infobox = infobox_parser.extract_infobox("infobox pet")
|
||||
if not has_infobox:
|
||||
self.template = None
|
||||
status["code"] = "no_infobox_template"
|
||||
return status
|
||||
|
||||
is_versioned = infobox_parser.determine_infobox_versions()
|
||||
versioned_ids = infobox_parser.extract_infobox_ids()
|
||||
|
||||
# Set the infobox version number, default to empty string (no version number)
|
||||
try:
|
||||
if versioned_ids:
|
||||
self.infobox_version_number = versioned_ids[item_id_to_process_int]
|
||||
except KeyError:
|
||||
if is_versioned:
|
||||
self.infobox_version_number = "1"
|
||||
else:
|
||||
self.infobox_version_number = ""
|
||||
|
||||
# Set the template
|
||||
self.template = infobox_parser.template
|
||||
|
||||
status["status"] = True
|
||||
return status
|
||||
|
||||
def populate_non_wiki_item(self):
|
||||
"""Populate an iem that has no wiki page."""
|
||||
self.populate_from_cache_data()
|
||||
|
||||
self.item_dict["tradeable"] = False
|
||||
self.item_dict["quest_item"] = False
|
||||
|
||||
self.item_dict["weight"] = None
|
||||
self.item_dict["buy_limit"] = None
|
||||
self.item_dict["release_date"] = None
|
||||
self.item_dict["examine"] = None
|
||||
self.item_dict["wiki_name"] = None
|
||||
self.item_dict["wiki_url"] = None
|
||||
|
||||
self.item_dict["equipable_by_player"] = False
|
||||
self.item_dict["equipable_weapon"] = False
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
try:
|
||||
self.item_dict["icon"] = self.icons[self.item_id_str]
|
||||
except KeyError:
|
||||
self.item_dict["icon"] = self.icons["blank"]
|
||||
|
||||
def populate_wiki_item(self):
|
||||
self.populate_from_cache_data()
|
||||
self.populate_from_wiki_data_properties()
|
||||
|
||||
if self.item_dict["equipable"]:
|
||||
self.populate_from_wiki_data_equipment()
|
||||
else:
|
||||
self.item_dict["equipable_by_player"] = False
|
||||
self.item_dict["equipable_weapon"] = False
|
||||
|
||||
try:
|
||||
self.item_dict["icon"] = self.icons[self.item_id_str]
|
||||
except KeyError:
|
||||
self.item_dict["icon"] = self.icons["blank"]
|
||||
|
||||
def populate_from_cache_data(self):
|
||||
"""Populate an item using raw cache data.
|
||||
|
||||
This function takes the raw OSRS cache data for the specific item and loads
|
||||
all available properties (that are extracted from the cache).
|
||||
"""
|
||||
# Populate properties from cache data
|
||||
self.item_dict["id"] = self.item_cache_data["id"]
|
||||
self.item_dict["name"] = self.item_cache_data["name"]
|
||||
self.item_dict["members"] = self.item_cache_data["members"]
|
||||
self.item_dict["stackable"] = self.item_cache_data["stackable"]
|
||||
self.item_dict["stacked"] = self.item_cache_data["stacked"]
|
||||
self.item_dict["noted"] = self.item_cache_data["noted"]
|
||||
self.item_dict["noteable"] = self.item_cache_data["noteable"]
|
||||
self.item_dict["linked_id_item"] = self.item_cache_data["linked_id_item"]
|
||||
self.item_dict["linked_id_noted"] = self.item_cache_data["linked_id_noted"]
|
||||
self.item_dict["linked_id_placeholder"] = self.item_cache_data["linked_id_placeholder"]
|
||||
self.item_dict["placeholder"] = self.item_cache_data["placeholder"]
|
||||
self.item_dict["equipable"] = self.item_cache_data["equipable"]
|
||||
self.item_dict["cost"] = self.item_cache_data["cost"]
|
||||
|
||||
# Set alch properties
|
||||
if self.item_cache_data["placeholder"]:
|
||||
self.item_dict["lowalch"] = None
|
||||
self.item_dict["highalch"] = None
|
||||
else:
|
||||
self.item_dict["lowalch"] = self.item_cache_data["lowalch"]
|
||||
self.item_dict["highalch"] = self.item_cache_data["highalch"]
|
||||
|
||||
# Set new, tradeable on ge property
|
||||
self.item_dict["tradeable_on_ge"] = self.item_cache_data["tradeable_on_ge"]
|
||||
# Fix for items that are not actually tradeable on the GE
|
||||
if self.item_dict["id"] in [2203, 4595, 7228, 7466, 8624, 8626, 8628]:
|
||||
self.item_dict["tradeable_on_ge"] = False
|
||||
|
||||
def populate_from_wiki_data_properties(self):
|
||||
"""Populate item data from a OSRS Wiki Infobox Item template."""
|
||||
# STAGE ONE: Determine then set the wiki_name, wiki_url properties
|
||||
|
||||
# Manually set OSRS Wiki name
|
||||
if self.wikitext_found_using not in ["id", "linked_id"]:
|
||||
# Item found in wiki by ID, cache name is the best option
|
||||
wiki_page_name = self.item_name
|
||||
else:
|
||||
# Item found using direct cache name lookup on wiki page names,
|
||||
# So use wiki page name in the item_wikitext array
|
||||
wiki_page_name = self.item_wikitext[0]
|
||||
|
||||
wiki_versioned_name = None
|
||||
wiki_name = None
|
||||
|
||||
# Get the versioned, or non-versioned, name from the infobox
|
||||
if self.infobox_version_number is not None:
|
||||
key = "version" + str(self.infobox_version_number)
|
||||
wiki_versioned_name = self.extract_infobox_value(self.template, key)
|
||||
else:
|
||||
wiki_versioned_name = self.extract_infobox_value(self.template, "version")
|
||||
|
||||
# Set the wiki_name property
|
||||
if wiki_versioned_name is not None:
|
||||
if wiki_versioned_name.startswith("("):
|
||||
wiki_name = wiki_page_name + " " + wiki_versioned_name
|
||||
else:
|
||||
wiki_name = wiki_page_name + " (" + wiki_versioned_name + ")"
|
||||
else:
|
||||
wiki_name = wiki_page_name
|
||||
|
||||
self.item_dict["wiki_name"] = wiki_name
|
||||
|
||||
# Set the wiki_url property
|
||||
if wiki_versioned_name is not None:
|
||||
wiki_url = wiki_page_name + "#" + wiki_versioned_name
|
||||
else:
|
||||
wiki_url = wiki_page_name
|
||||
|
||||
wiki_url = wiki_url.replace(" ", "_")
|
||||
self.item_dict["wiki_url"] = "https://oldschool.runescape.wiki/w/" + wiki_url
|
||||
|
||||
# Check if item is not actually able to be alched
|
||||
if wiki_name:
|
||||
if wiki_name in self.unalchable:
|
||||
self.item_dict["lowalch"] = None
|
||||
self.item_dict["highalch"] = None
|
||||
elif wiki_versioned_name in self.unalchable:
|
||||
self.item_dict["lowalch"] = None
|
||||
self.item_dict["highalch"] = None
|
||||
|
||||
# STAGE TWO: Extract and set item properties from the infobox template
|
||||
|
||||
# WEIGHT: Determine the weight of an item
|
||||
weight = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "weight" + str(self.infobox_version_number)
|
||||
weight = self.extract_infobox_value(self.template, key)
|
||||
if weight is None:
|
||||
weight = self.extract_infobox_value(self.template, "weight")
|
||||
if weight is not None:
|
||||
self.item_dict["weight"] = infobox_cleaner.weight(weight, self.item_id)
|
||||
else:
|
||||
self.item_dict["weight"] = None
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
# QUEST: Determine if item is associated with a quest
|
||||
quest = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "quest" + str(self.infobox_version_number)
|
||||
quest = self.extract_infobox_value(self.template, key)
|
||||
if quest is None:
|
||||
quest = self.extract_infobox_value(self.template, "quest")
|
||||
if quest is not None:
|
||||
self.item_dict["quest_item"] = infobox_cleaner.quest(quest)
|
||||
else:
|
||||
# Being here means the extraction for "quest" failed
|
||||
key = "questrequired" + str(self.infobox_version_number)
|
||||
quest = self.extract_infobox_value(self.template, key)
|
||||
if quest is None:
|
||||
quest = self.extract_infobox_value(self.template, "questrequired")
|
||||
if quest is not None:
|
||||
self.item_dict["quest_item"] = infobox_cleaner.quest(quest)
|
||||
else:
|
||||
self.item_dict["quest_item"] = False
|
||||
|
||||
# Determine the release date of an item
|
||||
release_date = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "release" + str(self.infobox_version_number)
|
||||
release_date = self.extract_infobox_value(self.template, key)
|
||||
if release_date is None:
|
||||
release_date = self.extract_infobox_value(self.template, "release")
|
||||
if release_date is not None:
|
||||
self.item_dict["release_date"] = infobox_cleaner.release_date(release_date)
|
||||
else:
|
||||
self.item_dict["release_date"] = None
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
# Determine if an item is tradeable
|
||||
tradeable = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "tradeable" + str(self.infobox_version_number)
|
||||
tradeable = self.extract_infobox_value(self.template, key)
|
||||
if tradeable is None:
|
||||
tradeable = self.extract_infobox_value(self.template, "tradeable")
|
||||
if tradeable is not None:
|
||||
self.item_dict["tradeable"] = infobox_cleaner.tradeable(tradeable)
|
||||
else:
|
||||
self.item_dict["tradeable"] = False
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
# Determine the examine text of an item
|
||||
examine = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "examine" + str(self.infobox_version_number)
|
||||
examine = self.extract_infobox_value(self.template, key)
|
||||
if examine is None:
|
||||
examine = self.extract_infobox_value(self.template, "examine")
|
||||
if examine is not None:
|
||||
self.item_dict["examine"] = infobox_cleaner.examine(examine, self.item_dict["name"])
|
||||
else:
|
||||
# Being here means the extraction for "examine" failed
|
||||
key = "itemexamine" + str(self.infobox_version_number)
|
||||
examine = self.extract_infobox_value(self.template, key)
|
||||
if examine is None:
|
||||
examine = self.extract_infobox_value(self.template, "itemexamine")
|
||||
if examine is not None:
|
||||
self.item_dict["examine"] = infobox_cleaner.examine(examine, self.item_dict["name"])
|
||||
else:
|
||||
self.item_dict["examine"] = None
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
# Set item buy limit, if it is tradeable on the GE
|
||||
if not self.item_dict["tradeable_on_ge"]:
|
||||
self.item_dict["buy_limit"] = None
|
||||
else:
|
||||
try:
|
||||
buy_limit = self.buy_limits[wiki_name]
|
||||
except KeyError:
|
||||
try:
|
||||
buy_limit = self.buy_limits[self.item_name]
|
||||
except KeyError:
|
||||
buy_limit = None
|
||||
|
||||
self.item_dict["buy_limit"] = buy_limit
|
||||
|
||||
# We finished processing, set incomplete to false if not true
|
||||
if not self.item_dict.get("incomplete"):
|
||||
self.item_dict["incomplete"] = False
|
||||
|
||||
def populate_from_wiki_data_equipment(self) -> bool:
|
||||
"""Parse the wiki text template and extract item bonus values from it."""
|
||||
# Hardcoded item skips - mostly unobtainable or weird items
|
||||
if int(self.item_id) in infobox_cleaner.unequipable:
|
||||
self.item_dict["equipable"] = False
|
||||
self.item_dict["equipment"] = None
|
||||
self.item_dict["equipable_by_player"] = False
|
||||
self.item_dict["equipable_weapon"] = False
|
||||
return
|
||||
|
||||
# Initialize empty equipment dictionary
|
||||
self.item_dict["equipment"] = dict()
|
||||
|
||||
# STAGE ONE: EQUIPMENT
|
||||
|
||||
# Extract the infobox bonuses template
|
||||
infobox_bonuses_parser = WikitextTemplateParser(self.item_wikitext)
|
||||
has_infobox = infobox_bonuses_parser.extract_infobox("infobox bonuses")
|
||||
if not has_infobox:
|
||||
has_infobox = infobox_bonuses_parser.extract_infobox("infobox_bonuses")
|
||||
if not has_infobox:
|
||||
# No infobox bonuses found for the item!
|
||||
print("populate_from_wiki_data_equipment: No infobox bonuses")
|
||||
exit(1)
|
||||
|
||||
# Set the infobox bonuses template
|
||||
bonuses_template = infobox_bonuses_parser.template
|
||||
|
||||
# This item must be equipable by a player, set to True
|
||||
self.item_dict["equipable_by_player"] = True
|
||||
|
||||
# Initialize a dictionary that maps database_name -> property_name
|
||||
# The database_name is used in this project
|
||||
# The property_name is used by the OSRS Wiki
|
||||
combat_bonuses = {"attack_stab": "astab",
|
||||
"attack_slash": "aslash",
|
||||
"attack_crush": "acrush",
|
||||
"attack_magic": "amagic",
|
||||
"attack_ranged": "arange",
|
||||
"defence_stab": "dstab",
|
||||
"defence_slash": "dslash",
|
||||
"defence_crush": "dcrush",
|
||||
"defence_magic": "dmagic",
|
||||
"defence_ranged": "drange",
|
||||
"melee_strength": "str",
|
||||
"ranged_strength": "rstr",
|
||||
"magic_damage": "mdmg",
|
||||
"prayer": "prayer"
|
||||
}
|
||||
|
||||
# Loop each of the combat bonuses and populate
|
||||
for database_name, property_name in combat_bonuses.items():
|
||||
value = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = property_name + str(self.infobox_version_number)
|
||||
value = self.extract_infobox_value(bonuses_template, key)
|
||||
if value is None:
|
||||
value = self.extract_infobox_value(bonuses_template, property_name)
|
||||
if value is not None:
|
||||
self.item_dict["equipment"][database_name] = infobox_cleaner.stats(value)
|
||||
else:
|
||||
self.item_dict["equipment"][database_name] = 0
|
||||
self.item_dict["incomplete"] = True
|
||||
|
||||
# Slot
|
||||
slot = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "slot" + str(self.infobox_version_number)
|
||||
slot = self.extract_infobox_value(bonuses_template, key)
|
||||
if slot is None:
|
||||
slot = self.extract_infobox_value(bonuses_template, "slot")
|
||||
if slot is not None:
|
||||
self.item_dict["equipment"]["slot"] = infobox_cleaner.caller(slot, "slot")
|
||||
else:
|
||||
print(">>> populate_from_wiki_data_equipment: No slot")
|
||||
exit(1)
|
||||
|
||||
# Skill requirements
|
||||
try:
|
||||
requirements = self.skill_requirements[self.item_id_str]
|
||||
self.item_dict["equipment"]["requirements"] = requirements
|
||||
except KeyError:
|
||||
self.item_dict["equipment"]["requirements"] = None
|
||||
|
||||
# If item is not weapon or 2h, start set defaults and return
|
||||
if (self.item_dict["equipment"]["slot"] not in ["weapon", "2h"]):
|
||||
self.item_dict["equipable_weapon"] = False
|
||||
return
|
||||
|
||||
# STAGE TWO: WEAPONS
|
||||
|
||||
self.item_dict["weapon"] = dict()
|
||||
|
||||
# Attack speed
|
||||
attack_speed = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "speed" + str(self.infobox_version_number)
|
||||
attack_speed = self.extract_infobox_value(bonuses_template, key)
|
||||
if attack_speed is None:
|
||||
attack_speed = self.extract_infobox_value(bonuses_template, "speed")
|
||||
if attack_speed is not None:
|
||||
self.item_dict["weapon"]["attack_speed"] = infobox_cleaner.caller(attack_speed, "speed")
|
||||
else:
|
||||
# If not present, set to 0
|
||||
self.item_dict["weapon"]["attack_speed"] = 0
|
||||
|
||||
# Weapon type
|
||||
# Extract the CombatStyles template
|
||||
infobox_combat_parser = WikitextTemplateParser(self.item_wikitext)
|
||||
has_infobox = infobox_combat_parser.extract_infobox("combatstyles")
|
||||
|
||||
if has_infobox:
|
||||
# There is a combatstyles infobox, parse it
|
||||
# Set the infobox bonuses template
|
||||
combat_template = infobox_combat_parser.template
|
||||
weapon_type = infobox_cleaner.caller(combat_template, "weapon_type")
|
||||
weapon_type = weapon_type.lower()
|
||||
if weapon_type == 'partisan':
|
||||
weapon_type = 'stab_sword'
|
||||
|
||||
self.item_dict["weapon"]["weapon_type"] = weapon_type
|
||||
try:
|
||||
self.item_dict["weapon"]["stances"] = self.weapon_stances[weapon_type]
|
||||
except KeyError:
|
||||
print(f"Missing weapon type: {weapon_type}")
|
||||
print("populate_from_wiki_data_equipment: Weapon type error 1")
|
||||
exit(1)
|
||||
|
||||
else:
|
||||
# No combatstyles infobox, try get data from bonuses
|
||||
weapon_type = self.extract_infobox_value(bonuses_template, "combatstyle")
|
||||
weapon_type = weapon_type.lower()
|
||||
weapon_type = weapon_type.replace(" ", "_")
|
||||
self.item_dict["weapon"]["weapon_type"] = weapon_type
|
||||
try:
|
||||
self.item_dict["weapon"]["stances"] = self.weapon_stances[weapon_type]
|
||||
except KeyError:
|
||||
print("populate_from_wiki_data_equipment: Weapon type error 2")
|
||||
exit(1)
|
||||
|
||||
# Finally, set the equipable_weapon property to true
|
||||
self.item_dict["equipable_weapon"] = True
|
||||
|
||||
def extract_infobox_value(self, template: mwparserfromhell.nodes.template.Template, key: str) -> str:
|
||||
"""Helper method to extract a value from a template using a specified key.
|
||||
|
||||
This helper method is a simple solution to repeatedly try to fetch a specific
|
||||
entry from a wiki text template (a mwparserfromhell template object).
|
||||
|
||||
:param template: A mediawiki wiki text template.
|
||||
:param key: The key to query in the template.
|
||||
:return value: The extracted template value based on supplied key.
|
||||
"""
|
||||
value = None
|
||||
try:
|
||||
value = template.get(key).value
|
||||
value = value.strip()
|
||||
return value
|
||||
except ValueError:
|
||||
return value
|
||||
|
||||
def check_duplicate_item(self) -> ItemProperties:
|
||||
"""Determine if this is a duplicate item.
|
||||
|
||||
:return: An ItemProperties object.
|
||||
"""
|
||||
# Start by setting the duplicate property to False
|
||||
self.item_dict["duplicate"] = False
|
||||
|
||||
# Check/set last update
|
||||
last_update = self.all_db_items.get(self.item_id, None)
|
||||
if last_update:
|
||||
self.item_dict["last_updated"] = self.all_db_items[self.item_id]["last_updated"]
|
||||
else:
|
||||
self.item_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
|
||||
# Create an ItemProperties object
|
||||
item_properties = ItemProperties(**self.item_dict)
|
||||
|
||||
# Check list of known bad duplicates
|
||||
if str(item_properties.id) in self.duplicates:
|
||||
duplicate_status = self.duplicates[str(item_properties.id)]["duplicate"]
|
||||
self.item_dict["duplicate"] = duplicate_status
|
||||
return None
|
||||
|
||||
# Check noted, placeholder and noted properties
|
||||
# If any of these properties, it must be a duplicate
|
||||
if item_properties.stacked or item_properties.noted or item_properties.placeholder:
|
||||
self.item_dict["duplicate"] = True
|
||||
return None
|
||||
|
||||
# Set the item properties that we want to compare
|
||||
correlation_properties = {
|
||||
"name": False,
|
||||
"wiki_name": False
|
||||
}
|
||||
|
||||
# Loop the list of currently (already processed) items
|
||||
for known_item in self.known_items:
|
||||
# Skip when cache names are not the same
|
||||
if item_properties.name != known_item.name:
|
||||
continue
|
||||
|
||||
# Check equality of each correlation property
|
||||
for cprop in correlation_properties:
|
||||
if getattr(item_properties, cprop) == getattr(known_item, cprop):
|
||||
correlation_properties[cprop] = True
|
||||
|
||||
# Check all values in correlation properties are True
|
||||
correlation_result = all(value is True for value in correlation_properties.values())
|
||||
|
||||
# If name and wiki_name match, set duplicate property to True
|
||||
if correlation_result:
|
||||
item_properties.duplicate = True
|
||||
self.item_dict["duplicate"] = True
|
||||
return item_properties
|
||||
|
||||
# If wiki_name is None, but cache names match...
|
||||
# The item must also be a duplicate
|
||||
if not item_properties.wiki_name:
|
||||
item_properties.duplicate = True
|
||||
self.item_dict["duplicate"] = True
|
||||
return item_properties
|
||||
|
||||
# If we made it this far, no duplicates were found
|
||||
item_properties.duplicate = False
|
||||
self.item_dict["duplicate"] = False
|
||||
return item_properties
|
||||
|
||||
def compare_new_vs_old_item(self) -> bool:
|
||||
"""Print the difference between this item and the database."""
|
||||
# Create JSON out object to compare
|
||||
item_properties = ItemProperties(**self.item_dict)
|
||||
current_json = item_properties.construct_json()
|
||||
|
||||
# Try get existing entry (KeyError means it doesn't exist - aka a new item)
|
||||
try:
|
||||
existing_json = self.all_db_items[self.item_id]
|
||||
except KeyError:
|
||||
print(f">>> compare_json_files: NEW ITEM: {item_properties.id}")
|
||||
print(current_json)
|
||||
self.item_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
return
|
||||
|
||||
if current_json == existing_json:
|
||||
self.item_dict["last_updated"] = self.all_db_items[self.item_id]["last_updated"]
|
||||
return
|
||||
|
||||
ddiff = DeepDiff(existing_json, current_json, ignore_order=True, exclude_paths="root['icon']")
|
||||
|
||||
if ddiff:
|
||||
print(f">>> compare_json_files: CHANGED ITEM: {item_properties.id}: {item_properties.name}")
|
||||
print(ddiff)
|
||||
self.item_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
|
||||
def export_item_to_json(self):
|
||||
"""Export item to JSON, if requested."""
|
||||
item_properties = ItemProperties(**self.item_dict)
|
||||
output_dir = Path(config.DOCS_PATH, "items-json")
|
||||
item_properties.export_json(True, output_dir)
|
||||
|
||||
def validate_item(self):
|
||||
"""Use the schema-items.json file to validate the populated item."""
|
||||
# Create JSON out object to validate
|
||||
item_properties = ItemProperties(**self.item_dict)
|
||||
current_json = item_properties.construct_json()
|
||||
|
||||
# Validate object with schema attached
|
||||
v = validator.MyValidator(self.schema_data)
|
||||
v.validate(current_json)
|
||||
|
||||
# Print any validation errors
|
||||
if v.errors:
|
||||
print(v.errors)
|
||||
exit(1)
|
||||
|
||||
assert v.validate(current_json)
|
||||
217
builders/items/builder.py
Normal file
217
builders/items/builder.py
Normal file
|
|
@ -0,0 +1,217 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Program to invoke item database generation process.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from builders.items import build_item
|
||||
|
||||
|
||||
class Builder:
|
||||
def __init__(self, **kwargs):
|
||||
# Set properties to control phases of build
|
||||
self.verbose = kwargs["verbose"]
|
||||
self.compare = kwargs["compare"]
|
||||
self.export = kwargs["export"]
|
||||
self.validate = kwargs["validate"]
|
||||
|
||||
# Load the raw cache data that has been processed (this is ground truth)
|
||||
with open(Path(config.DATA_ITEMS_PATH / "items-cache-data.json")) as f:
|
||||
self.all_items_cache_data = json.load(f)
|
||||
|
||||
# Load all item data (from min JSON file)
|
||||
# with open(Path(config.DOCS_PATH / "items-complete.json")) as f:
|
||||
# self.all_db_items = json.load(f)
|
||||
self.all_db_items = dict()
|
||||
|
||||
# Load the item wikitext file of page text
|
||||
with open(Path(config.DATA_ITEMS_PATH / "items-wiki-page-text.json")) as f:
|
||||
self.all_wikitext_raw = json.load(f)
|
||||
|
||||
# Load the item wikitext file of processed data
|
||||
with open(Path(config.DATA_ITEMS_PATH / "items-wiki-page-text-processed.json")) as f:
|
||||
self.all_wikitext_processed = json.load(f)
|
||||
|
||||
# Load dict of unalchable items
|
||||
unalchable_items_path = Path(config.DATA_ITEMS_PATH / "items-unalchable.json")
|
||||
with open(unalchable_items_path) as f:
|
||||
self.unalchable = json.load(f)
|
||||
|
||||
# Load buy limit data
|
||||
buy_limits_file_path = Path(config.DATA_ITEMS_PATH / "items-buylimits.json")
|
||||
with open(buy_limits_file_path) as f:
|
||||
self.buy_limits = json.load(f)
|
||||
|
||||
# Load skill requirement data
|
||||
skill_requirements_file_path = Path(config.STATICS_PATH / "items-skill-requirements.json")
|
||||
with open(skill_requirements_file_path) as f:
|
||||
self.skill_requirements = json.load(f)
|
||||
|
||||
# Load stances data
|
||||
weapon_stance_file_path = Path(config.STATICS_PATH / "weapon-stances.json")
|
||||
with open(weapon_stance_file_path) as f:
|
||||
self.weapon_stances = json.load(f)
|
||||
|
||||
# Load icon data
|
||||
icons_file_path = Path(config.DATA_ICONS_PATH / "icons-items-complete.json")
|
||||
with open(icons_file_path) as f:
|
||||
self.icons = json.load(f)
|
||||
|
||||
# Load duplicate item data
|
||||
duplicates_file_path = Path(config.STATICS_PATH / "items-duplicates.json")
|
||||
with open(duplicates_file_path) as f:
|
||||
self.duplicates = json.load(f)
|
||||
|
||||
# Load schema data
|
||||
with open(Path(config.DATA_SCHEMAS_PATH / "schema-items.json")) as f:
|
||||
self.schema_data = json.load(f)
|
||||
|
||||
# Initialize a list of known items
|
||||
self.known_items = list()
|
||||
|
||||
def run(self):
|
||||
# Start processing every item!
|
||||
for item_id in self.all_items_cache_data:
|
||||
|
||||
# if int(item_id) < 25800:
|
||||
# continue
|
||||
|
||||
# Skip any beta items
|
||||
if "(beta" in self.all_items_cache_data[item_id]["name"]:
|
||||
continue
|
||||
|
||||
# Initialize the BuildItem class, used for all items
|
||||
builder = build_item.BuildItem(item_id=item_id,
|
||||
all_items_cache_data=self.all_items_cache_data,
|
||||
all_db_items=self.all_db_items,
|
||||
all_wikitext_raw=self.all_wikitext_raw,
|
||||
all_wikitext_processed=self.all_wikitext_processed,
|
||||
unalchable=self.unalchable,
|
||||
buy_limits=self.buy_limits,
|
||||
skill_requirements=self.skill_requirements,
|
||||
weapon_stances=self.weapon_stances,
|
||||
icons=self.icons,
|
||||
duplicates=self.duplicates,
|
||||
schema_data=self.schema_data,
|
||||
known_items=self.known_items,
|
||||
verbose=self.verbose)
|
||||
|
||||
status = builder.preprocessing()
|
||||
|
||||
if status["status"]:
|
||||
builder.populate_wiki_item()
|
||||
else:
|
||||
builder.populate_non_wiki_item()
|
||||
|
||||
known_item = builder.check_duplicate_item()
|
||||
if known_item:
|
||||
self.known_items.append(known_item)
|
||||
if self.compare:
|
||||
builder.compare_new_vs_old_item()
|
||||
if self.export:
|
||||
builder.export_item_to_json()
|
||||
if self.validate:
|
||||
builder.validate_item()
|
||||
|
||||
# Done processing, rejoice!
|
||||
print("Built.")
|
||||
exit(0)
|
||||
|
||||
def test(self):
|
||||
# Start processing every item!
|
||||
for item_id in self.all_items_cache_data:
|
||||
|
||||
# if int(item_id) < 25800:
|
||||
# continue
|
||||
|
||||
# Skip any beta items
|
||||
if "(beta" in self.all_items_cache_data[item_id]["name"]:
|
||||
continue
|
||||
|
||||
# Initialize the BuildItem class, used for all items
|
||||
builder = build_item.BuildItem(item_id=item_id,
|
||||
all_items_cache_data=self.all_items_cache_data,
|
||||
all_db_items=self.all_db_items,
|
||||
all_wikitext_raw=self.all_wikitext_raw,
|
||||
all_wikitext_processed=self.all_wikitext_processed,
|
||||
unalchable=self.unalchable,
|
||||
buy_limits=self.buy_limits,
|
||||
skill_requirements=self.skill_requirements,
|
||||
weapon_stances=self.weapon_stances,
|
||||
icons=self.icons,
|
||||
duplicates=self.duplicates,
|
||||
schema_data=self.schema_data,
|
||||
known_items=self.known_items,
|
||||
verbose=self.verbose)
|
||||
|
||||
status = builder.preprocessing()
|
||||
|
||||
if status["status"]:
|
||||
builder.populate_wiki_item()
|
||||
else:
|
||||
builder.populate_non_wiki_item()
|
||||
|
||||
known_item = builder.check_duplicate_item()
|
||||
if known_item:
|
||||
self.known_items.append(known_item)
|
||||
builder.validate_item()
|
||||
|
||||
# Done testing, rejoice!
|
||||
print("Tested.")
|
||||
exit(0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(description="Build item database.")
|
||||
parser.add_argument('--verbose',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to be verbose.')
|
||||
parser.add_argument('--compare',
|
||||
default=True,
|
||||
required=False,
|
||||
help='A boolean of whether to compare data.')
|
||||
parser.add_argument('--export',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to export data.')
|
||||
parser.add_argument('--validate',
|
||||
default=True,
|
||||
required=False,
|
||||
help='A boolean of whether to validate using schema.')
|
||||
parser.add_argument('--test',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to test the builder process.')
|
||||
args = parser.parse_args()
|
||||
|
||||
builder = Builder(verbose=args.verbose,
|
||||
compare=args.compare,
|
||||
export=args.export,
|
||||
validate=args.validate)
|
||||
if args.test:
|
||||
builder.test()
|
||||
else:
|
||||
builder.run()
|
||||
495
builders/items/infobox_cleaner.py
Normal file
495
builders/items/infobox_cleaner.py
Normal file
|
|
@ -0,0 +1,495 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Various methods to help clean OSRS Wiki wikitext entries.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import re
|
||||
from datetime import datetime
|
||||
|
||||
import dateparser
|
||||
|
||||
|
||||
# Source: runelite/runelite-wiki-scraper
|
||||
WEIGHT_REDUCTION_EXTRACTOR = re.compile(
|
||||
r"(?i)'''(?:In )?inventory:?''':? ([0-9.-]+) kg<br ?\/?> *'''Equipped:?''':? ([0-9.-]+)")
|
||||
|
||||
unequipable = [
|
||||
286, # Orange goblin mail
|
||||
287, # Blue goblin mail,
|
||||
288, # Goblin mail
|
||||
740, # Blue hat (Legends' Quest)
|
||||
713, # Clue scroll
|
||||
818, # Poisoned dart(p)
|
||||
1235, # Poisoned dagger(p)
|
||||
2422, # Blue partyhat (Draynor Bank Robbery)
|
||||
2513, # Dragon chainbody (My Arm's Big Adventure)
|
||||
4178, # Abyssal whip (My Arm's Big Adventure)
|
||||
4180, # Dragon platelegs (My Arm's Big Adventure)
|
||||
4181, # Mouth grip
|
||||
4213, # New crystal bow
|
||||
4235, # New crystal shield
|
||||
5056, # Dwarven battleaxe
|
||||
5057, # Dwarven battleaxe
|
||||
5058, # Dwarven battleaxe
|
||||
5059, # Dwarven battleaxe
|
||||
5062, # Left boot
|
||||
5063, # Right boot
|
||||
5064, # Exquisite boots
|
||||
5067, # Exquisite clothes
|
||||
5684, # Poison dagger(p+)
|
||||
5702, # Poison dagger(p++)
|
||||
6788, # Torn robe
|
||||
6789, # Torn robe
|
||||
6818, # Bow-sword
|
||||
6864, # Marionette handle
|
||||
6893, # Leather boots (Mage Training Arena)
|
||||
6894, # Adamant kiteshield (Mage Training Arena)
|
||||
6895, # Adamant med helm (Mage Training Arena)
|
||||
6897, # Rune longsword (Mage Training Arena)
|
||||
6967, # Dragon med helm (My Arm's Big Adventure)
|
||||
7804, # Zaros mjolnir
|
||||
8871, # Crate with zanik [TODO: no attack speed]
|
||||
8856, # Defensive shield [TODO: no weapon type]
|
||||
9054, # Red goblin mail
|
||||
9055, # Black goblin mail
|
||||
9056, # Yellow goblin mail
|
||||
9057, # Green goblin mail
|
||||
9058, # Purple goblin mail
|
||||
9059, # Pink goblin mail
|
||||
9665, # Torch
|
||||
9702, # Stick
|
||||
9906, # Ghost buster 500
|
||||
9907, # Ghost buster 500
|
||||
9908, # Ghost buster 500
|
||||
9909, # Ghost buster 500
|
||||
9910, # Ghost buster 500
|
||||
9911, # Ghost buster 500
|
||||
9912, # Ghost buster 500
|
||||
10840, # A jester stick
|
||||
11165, # Phoenix crossbow
|
||||
11167, # Phoenix crossbow
|
||||
11700, # Bronze arrow (Barbarian Assault)
|
||||
11701, # Iron arrow (Barbarian Assault)
|
||||
11702, # Steel arrow (Barbarian Assault)
|
||||
11703, # Mithril arrow (Barbarian Assault)
|
||||
22664, # Scythe of vitur (JMod item)
|
||||
22665, # Armadyl godsword (JMod item)
|
||||
22666, # Rubber chicken (JMod item)
|
||||
10556, # Attacker icon
|
||||
22346, # Attacker icon
|
||||
22347, # Attacker icon
|
||||
22348, # Attacker icon
|
||||
22349, # Attacker icon
|
||||
22721, # Attacker icon
|
||||
22722, # Attacker icon
|
||||
22723, # Attacker icon
|
||||
22729, # Attacker icon
|
||||
22730, # Attacker icon
|
||||
23460, # Attacker icon
|
||||
23461, # Attacker icon
|
||||
23462, # Attacker icon
|
||||
23463, # Attacker icon
|
||||
23464, # Attacker icon
|
||||
23465, # Attacker icon
|
||||
10558, # Defender icon
|
||||
22340, # Defender icon
|
||||
22341, # Defender icon
|
||||
22342, # Defender icon
|
||||
22343, # Defender icon
|
||||
22344, # Defender icon
|
||||
22345, # Defender icon
|
||||
22725, # Defender icon
|
||||
22726, # Defender icon
|
||||
22727, # Defender icon
|
||||
22728, # Defender icon
|
||||
23466, # Defender icon
|
||||
23467, # Defender icon
|
||||
23468, # Defender icon
|
||||
23469, # Defender icon
|
||||
23470, # Defender icon
|
||||
10557, # Collector icon
|
||||
22312, # Collector icon
|
||||
22313, # Collector icon
|
||||
22314, # Collector icon
|
||||
22315, # Collector icon
|
||||
22337, # Collector icon
|
||||
22338, # Collector icon
|
||||
22339, # Collector icon
|
||||
22724, # Collector icon
|
||||
23471, # Collector icon
|
||||
23472, # Collector icon
|
||||
23473, # Collector icon
|
||||
23474, # Collector icon
|
||||
23475, # Collector icon
|
||||
23476, # Collector icon
|
||||
23477, # Collector icon
|
||||
10559, # Healer icon
|
||||
10567, # Healer icon
|
||||
20802, # Healer icon
|
||||
22308, # Healer icon
|
||||
22309, # Healer icon
|
||||
22310, # Healer icon
|
||||
22311, # Healer icon
|
||||
23478, # Healer icon
|
||||
23479, # Healer icon
|
||||
23480, # Healer icon
|
||||
23481, # Healer icon
|
||||
23482, # Healer icon
|
||||
23483, # Healer icon
|
||||
23484, # Healer icon
|
||||
23485, # Healer icon
|
||||
23486, # Healer icon
|
||||
13538, # Shayzien supply gloves (1)
|
||||
13539, # Shayzien supply boots (1)
|
||||
13540, # Shayzien supply helm (1)
|
||||
13541, # Shayzien supply greaves (1)
|
||||
13542, # Shayzien supply platebody (1)
|
||||
13543, # Shayzien supply gloves (2)
|
||||
13544, # Shayzien supply boots (2)
|
||||
13545, # Shayzien supply helm (2)
|
||||
13546, # Shayzien supply greaves (2)
|
||||
13547, # Shayzien supply platebody (2)
|
||||
13548, # Shayzien supply gloves (3)
|
||||
13549, # Shayzien supply boots (3)
|
||||
13550, # Shayzien supply helm (3)
|
||||
13551, # Shayzien supply greaves (3)
|
||||
13552, # Shayzien supply platebody (3)
|
||||
13553, # Shayzien supply gloves (4)
|
||||
13554, # Shayzien supply boots (4)
|
||||
13555, # Shayzien supply helm (4)
|
||||
13556, # Shayzien supply greaves (4)
|
||||
13557, # Shayzien supply platebody (4)
|
||||
13558, # Shayzien supply gloves (5)
|
||||
13559, # Shayzien supply boots (5)
|
||||
13560, # Shayzien supply helm (5)
|
||||
13561, # Shayzien supply greaves (5)
|
||||
13562, # Shayzien supply platebody (5)
|
||||
21428, # Wilderness cape (Wilderness Wars)
|
||||
21429, # Wilderness cape (Wilderness Wars)
|
||||
21430, # Wilderness cape (Wilderness Wars)
|
||||
21431, # Wilderness cape (Wilderness Wars)
|
||||
21432, # Wilderness cape (Wilderness Wars)
|
||||
21433, # Wilderness champion amulet
|
||||
21434, # Wilderness cape (Wilderness Wars, Champion)
|
||||
21435, # Wilderness cape (Wilderness Wars, Champion)
|
||||
21436, # Wilderness cape (Wilderness Wars, Champion)
|
||||
21437, # Wilderness cape (Wilderness Wars, Champion)
|
||||
21438, # Wilderness cape (Wilderness Wars, Champion)
|
||||
22812, # Dragon knife (animation item)
|
||||
22814, # Dragon knife (animation item)
|
||||
25212, # Blue icon
|
||||
25213, # Blue icon
|
||||
25214, # Blue icon
|
||||
25215, # Blue icon
|
||||
25216, # Blue icon
|
||||
25217, # Blue icon
|
||||
25218, # Blue icon
|
||||
25219, # Blue icon
|
||||
25220, # Blue icon
|
||||
25221, # Blue icon
|
||||
25222, # Blue icon
|
||||
25223, # Blue icon
|
||||
25224, # Blue icon
|
||||
25225, # Blue icon
|
||||
25226, # Blue icon
|
||||
25227, # Blue icon
|
||||
25228, # Red icon
|
||||
25229, # Red icon
|
||||
25230, # Red icon
|
||||
25231, # Red icon
|
||||
25232, # Red icon
|
||||
25233, # Red icon
|
||||
25234, # Red icon
|
||||
25235, # Red icon
|
||||
25236, # Red icon
|
||||
25237, # Red icon
|
||||
25238, # Red icon
|
||||
25239, # Red icon
|
||||
25240, # Red icon
|
||||
25241, # Red icon
|
||||
25242, # Red icon
|
||||
25243, # Red icon
|
||||
25987, # Tumeken's heka
|
||||
25989, # Tumeken's heka (uncharged)
|
||||
]
|
||||
|
||||
|
||||
def clean_wikitext(value: str) -> str:
|
||||
"""Generic infobox property cleaner.
|
||||
|
||||
This helper method is a generic cleaner for all infobox template properties.
|
||||
The value is string cast, stipped of new line characters, then any square
|
||||
brackets (wikitext links) are stripped, then anything in trailing brackets,
|
||||
then any HTML line breaks are removed.
|
||||
|
||||
:param value: Template value extracted in raw wikitext format.
|
||||
:return value: Template value with square brackets stripped.
|
||||
"""
|
||||
value = str(value)
|
||||
value = value.strip()
|
||||
value = re.sub(r'[\[\]]+', '', value) # Removes all "[" and "]"
|
||||
value = re.sub(r' \([^()]*\)', '', value) # Removes " (anything)"
|
||||
value = re.sub(r'<!--(.*?)-->', '', value) # Removes "<!--anything-->"
|
||||
value = re.sub(r'<br(.*)', '', value) # Removes "<br"
|
||||
return value
|
||||
|
||||
|
||||
def caller(value: str, prop: str):
|
||||
"""Calls specific function based on property name.
|
||||
|
||||
Since there is a dict loop method to reduce code duplication,
|
||||
there needs to be a way to call the function that matches the
|
||||
property. This helps call the function and return the cleaned
|
||||
values.
|
||||
|
||||
:param value: Template value extracted in raw wikitext format.
|
||||
:param prop: The template property being processed.
|
||||
:return value: Cleaned template value.
|
||||
"""
|
||||
value = globals()[prop](value)
|
||||
return value
|
||||
|
||||
|
||||
def weight(value: str, item_id: int) -> float:
|
||||
"""Convert the weight entry from a OSRS Wiki infobox to a float.
|
||||
|
||||
:param value: Template value extracted in raw wikitext format.
|
||||
:param item_id: The item ID number.
|
||||
:return weight: The weight of an item.
|
||||
"""
|
||||
if value is None or value == "":
|
||||
return None
|
||||
|
||||
item_id = int(item_id)
|
||||
|
||||
# Handle weight reducing items as ID changes when equipped
|
||||
if item_id in [10073]:
|
||||
# Spotted cape
|
||||
return -2.2
|
||||
elif item_id in [89, 10554, 10074]:
|
||||
# Boots of lightness, Penance gloves, Spottier cape
|
||||
return -4.5
|
||||
elif item_id in [13342, 13340, 13341]:
|
||||
# Max cape, Agility cape, Agility cape (t)
|
||||
return -4.0
|
||||
elif item_id in [11851, 13580, 13592, 13604, 13616, 13628, 13668, 21063]:
|
||||
# Graceful hood variants
|
||||
return -3.0
|
||||
elif item_id in [11853, 13582, 13594, 13606, 13618, 13630, 13670, 21066]:
|
||||
# Graceful cape variants
|
||||
return -4.0
|
||||
elif item_id in [11855, 13584, 13596, 13608, 13620, 13632, 13672, 21069]:
|
||||
# Graceful top variants
|
||||
return -5.0
|
||||
elif item_id in [11857, 13586, 13598, 13610, 13622, 13634, 13674, 21072]:
|
||||
# Graceful legs variants
|
||||
return -6.0
|
||||
elif item_id in [11859, 13588, 13600, 13612, 13624, 13636, 13676, 21075]:
|
||||
# Graceful gloves variants
|
||||
return -3.0
|
||||
elif item_id in [11861, 13590, 13602, 13614, 13626, 13638, 13678, 21078]:
|
||||
# Graceful boots variants
|
||||
return -4.0
|
||||
|
||||
if value.endswith("kg"):
|
||||
value = value[:-2].strip()
|
||||
else:
|
||||
value = str(value).strip()
|
||||
|
||||
# The weight property is usally quite clean...
|
||||
# Try float cast the value, and return
|
||||
try:
|
||||
return float(value)
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
# Handle when there is inventory/equipable weights
|
||||
# Source: runelite/runelite-wiki-scraper
|
||||
reducer = WEIGHT_REDUCTION_EXTRACTOR.match(value)
|
||||
if reducer:
|
||||
# Get inventory weight (as worn wieght handled above)
|
||||
# Group 1 is inventory, 2 is equipped
|
||||
value = reducer.group(1)
|
||||
value = float(value)
|
||||
return value
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def quest(value: str) -> bool:
|
||||
"""Convert the quest entry from an OSRS Wiki infobox to a boolean.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:return quest: A boolean to identify if an item is associated with a quest.
|
||||
"""
|
||||
if value is None:
|
||||
return False
|
||||
|
||||
quest = str(value).strip().lower()
|
||||
if quest in ["yes"]:
|
||||
return True
|
||||
elif "[[" in quest:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def release_date(value: str) -> str:
|
||||
"""Convert the release date entry to ISO 8601 date format.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:return release_date: A cleaned release date of an item.
|
||||
"""
|
||||
release_date = clean_wikitext(value)
|
||||
|
||||
if release_date == "":
|
||||
return None
|
||||
|
||||
try:
|
||||
release_date = datetime.strptime(release_date, "%d %B %Y")
|
||||
return release_date.date().isoformat()
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
try:
|
||||
release_date = dateparser.parse(release_date)
|
||||
release_date = release_date.date().isoformat()
|
||||
except (ValueError, TypeError, AttributeError):
|
||||
return None
|
||||
|
||||
|
||||
def tradeable(value: str) -> bool:
|
||||
"""Convert the tradeable entry from an OSRS Wiki infobox to a boolean.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:return quest: A boolean to identify if an item is tradeable.
|
||||
"""
|
||||
# Clean a quest value
|
||||
tradeable = str(value).strip().lower()
|
||||
|
||||
if tradeable in ["yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def examine(value: str, name: str) -> str:
|
||||
"""Convert the examine text entry from an OSRS Wiki infobox.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:param name: The name of the item being processed.
|
||||
:return tradeable: A cleaned tradeable property of an item.
|
||||
"""
|
||||
examine = str(value)
|
||||
examine = examine.strip()
|
||||
|
||||
# Apart from "Clue scroll (master)" and "Clue scroll (beginner)"
|
||||
# clues have variable examine text
|
||||
clue_scrolls = ["Clue scroll (easy)",
|
||||
"Clue scroll (medium)",
|
||||
"Clue scroll (hard)",
|
||||
"Clue scroll (elite)"]
|
||||
if name in clue_scrolls:
|
||||
return "A clue!"
|
||||
|
||||
# Medium clue keys are also variable (but not other key variants)
|
||||
# Set to first value available
|
||||
if name == "Key (medium)":
|
||||
return "A key to unlock a treasure chest."
|
||||
|
||||
# Ghrim's book
|
||||
# Example: ''Managing Thine Kingdom for Noobes'' by A. Ghrim.
|
||||
if name == "Ghrim's book":
|
||||
examine = examine.replace("''", "")
|
||||
return examine
|
||||
|
||||
# Pet smoke devil
|
||||
# Example: <nowiki>*cough*</nowiki>
|
||||
if name == "Pet smoke devil":
|
||||
return "*cough*"
|
||||
|
||||
# Fix for quest related examine texts (mostly for keys)
|
||||
examine = re.sub(r' \([^()]*\)', '', examine)
|
||||
|
||||
# Remove sic
|
||||
examine = examine.replace("{{sic}}", "")
|
||||
|
||||
return examine
|
||||
|
||||
|
||||
def stats(value: str) -> int:
|
||||
"""Convert a item stat value to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned stat value as an int.
|
||||
"""
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return 0
|
||||
|
||||
|
||||
def slot(value: str) -> str:
|
||||
"""Convert a slot value to a cleaned string.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned slot value as an str.
|
||||
"""
|
||||
if "\n" in value: # TODO: Remove when comment fixed in fish sack barrel
|
||||
value = value.split("\n")[0]
|
||||
|
||||
try:
|
||||
return value.lower()
|
||||
except ValueError:
|
||||
return ""
|
||||
|
||||
|
||||
def speed(value: str) -> int:
|
||||
"""Convert a item weapon speed value to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned speed value as an int.
|
||||
"""
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def weapon_type(value: str) -> str:
|
||||
"""Convert a item weapon type value to a clean string.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned weapon type value.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
value = value.replace("{", "").replace("}", "")
|
||||
value = value.replace(" ", "_")
|
||||
value = value.lower()
|
||||
|
||||
try:
|
||||
value = value.split("|")[1]
|
||||
except IndexError:
|
||||
return None
|
||||
|
||||
return value
|
||||
423
builders/monsters/build_monster.py
Normal file
423
builders/monsters/build_monster.py
Normal file
|
|
@ -0,0 +1,423 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Build a monster given OSRS cache, wiki and custom data.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from datetime import timezone
|
||||
|
||||
import mwparserfromhell
|
||||
from deepdiff import DeepDiff
|
||||
|
||||
import config
|
||||
import validator
|
||||
from builders.monsters import infobox_cleaner
|
||||
from scripts.wiki.wikitext_parser import WikitextTemplateParser
|
||||
from osrsbox.monsters_api.monster_properties import MonsterProperties
|
||||
|
||||
|
||||
class BuildMonster:
|
||||
def __init__(self, **kwargs):
|
||||
# ID number to process
|
||||
self.monster_id = kwargs["monster_id"]
|
||||
# Raw cache data for all monsters
|
||||
self.all_monster_cache_data = kwargs["all_monster_cache_data"]
|
||||
# The existing monster database contents
|
||||
self.all_db_monsters = kwargs["all_db_monsters"]
|
||||
# Raw data dump from OSRS Wiki
|
||||
self.all_wikitext_raw = kwargs["all_wikitext_raw"]
|
||||
# Processed wikitext for all monsters
|
||||
self.all_wikitext_processed = kwargs["all_wikitext_processed"]
|
||||
# Processed monster drops
|
||||
self.monsters_drops = kwargs["monsters_drops"]
|
||||
# The monster schema
|
||||
self.schema_data = kwargs["schema_data"]
|
||||
# A list of already known (processed) monsters
|
||||
self.known_monsters = kwargs["known_monsters"]
|
||||
# Specify verbosity
|
||||
self.verbose = kwargs["verbose"]
|
||||
|
||||
# For this monster instance, create dictionary for property storage
|
||||
self.monster_dict = dict()
|
||||
# The page name the wikitext is from
|
||||
self.wiki_page_name = None
|
||||
# The version used on the wikitext page
|
||||
self.infobox_version_number = None
|
||||
# Used if the item is special (invalid, normalized etc.)
|
||||
self.status = None
|
||||
|
||||
def preprocessing(self):
|
||||
"""Preprocess an monster, and set important object variables.
|
||||
|
||||
This function preprocesses every monster dumped from the OSRS cache. Various
|
||||
properties are set to help further processing. MORE."""
|
||||
# Set monster ID variables
|
||||
self.monster_id_int = int(self.monster_id) # Monster ID number as an integer
|
||||
self.monster_id_str = str(self.monster_id) # Monster ID number as a string
|
||||
|
||||
# Load monster dictionary of cache data based on monster ID
|
||||
# This raw cache data is the baseline information about the specific monster
|
||||
# and can be considered 100% correct and available for every monster
|
||||
self.monster_cache_data = self.all_monster_cache_data[self.monster_id_str]
|
||||
|
||||
# Set monster name variable (directly from the cache dump)
|
||||
self.monster_name = self.monster_cache_data["name"]
|
||||
|
||||
# Log and print monster
|
||||
if self.verbose:
|
||||
print(f"======================= {self.monster_id_str} {self.monster_name}")
|
||||
|
||||
# Set all variables to None (for invalid monsters)
|
||||
self.monster_wikitext = None
|
||||
self.wikitext_found_using = None
|
||||
self.has_infobox = False
|
||||
|
||||
# Try to find the wiki data using direct ID number search
|
||||
if self.all_wikitext_processed.get(self.monster_id_str, None):
|
||||
self.monster_wikitext = self.all_wikitext_processed.get(self.monster_id_str, None)
|
||||
self.wikitext_found_using = "id"
|
||||
|
||||
# Try to find the wiki data using direct name search
|
||||
elif self.all_wikitext_raw.get(self.monster_name, None):
|
||||
self.monster_wikitext = self.all_wikitext_raw.get(self.monster_name, None)
|
||||
self.wikitext_found_using = "name"
|
||||
|
||||
# If there is no wikitext, and the monster is valid, raise a critical error
|
||||
if not self.monster_wikitext:
|
||||
return False
|
||||
|
||||
# Parse the infobox monster
|
||||
infobox_parser = WikitextTemplateParser(self.monster_wikitext)
|
||||
|
||||
# Try extract infobox for monster
|
||||
self.has_infobox = infobox_parser.extract_infobox("infobox monster")
|
||||
if not self.has_infobox:
|
||||
return False
|
||||
|
||||
self.is_versioned = infobox_parser.determine_infobox_versions()
|
||||
self.versioned_ids = infobox_parser.extract_infobox_ids()
|
||||
|
||||
# Set the infobox version number, default to empty string (no version number)
|
||||
try:
|
||||
if self.versioned_ids:
|
||||
self.infobox_version_number = self.versioned_ids[self.monster_id_int]
|
||||
except KeyError:
|
||||
if self.is_versioned:
|
||||
self.infobox_version_number = "1"
|
||||
else:
|
||||
self.infobox_version_number = ""
|
||||
|
||||
# Set the template
|
||||
self.template = infobox_parser.template
|
||||
|
||||
return True
|
||||
|
||||
def populate_monster(self):
|
||||
"""Populate a monster after preprocessing it.
|
||||
|
||||
This is called for every monster in the OSRS cache dump that has a wiki page.
|
||||
Start by populating the raw metadata from the cache. Then use the wiki data
|
||||
to populate more properties.
|
||||
"""
|
||||
self.populate_from_cache_data()
|
||||
self.populate_monster_properties_from_wiki_data()
|
||||
|
||||
def populate_from_cache_data(self):
|
||||
"""Populate a monster using raw cache data.
|
||||
|
||||
This function takes the raw OSRS cache data for the specific monster and loads
|
||||
all available properties (that are extracted from the cache)."""
|
||||
# Log, then populate cache properties
|
||||
self.monster_dict["id"] = self.monster_cache_data["id"]
|
||||
self.monster_dict["name"] = self.monster_cache_data["name"]
|
||||
self.monster_dict["combat_level"] = self.monster_cache_data["combatLevel"]
|
||||
self.monster_dict["size"] = self.monster_cache_data["size"]
|
||||
|
||||
def populate_monster_properties_from_wiki_data(self):
|
||||
"""Populate item data from a OSRS Wiki Infobox Item template."""
|
||||
# STAGE ONE: Determine then set the wiki_name and wiki_url
|
||||
|
||||
# Manually set OSRS Wiki name
|
||||
if self.wikitext_found_using not in ["id"]:
|
||||
# Monster found in wiki by ID, cache name is the best option
|
||||
wiki_page_name = self.monster_name
|
||||
else:
|
||||
# Monster found using direct cache name lookup on wiki page names,
|
||||
# So use wiki page name in the monster_wikitext array
|
||||
wiki_page_name = self.monster_wikitext[0]
|
||||
|
||||
wiki_versioned_name = None
|
||||
wiki_name = None
|
||||
|
||||
# Get the versioned, or non-versioned, name from the infobox
|
||||
if self.infobox_version_number is not None:
|
||||
key = "version" + str(self.infobox_version_number)
|
||||
wiki_versioned_name = self.extract_infobox_value(self.template, key)
|
||||
else:
|
||||
wiki_versioned_name = self.extract_infobox_value(self.template, "version")
|
||||
|
||||
# Set the wiki_name property
|
||||
if wiki_versioned_name is not None:
|
||||
if wiki_versioned_name.startswith("("):
|
||||
wiki_name = wiki_page_name + " " + wiki_versioned_name
|
||||
else:
|
||||
wiki_name = wiki_page_name + " (" + wiki_versioned_name + ")"
|
||||
else:
|
||||
wiki_name = wiki_page_name
|
||||
|
||||
self.monster_dict["wiki_name"] = wiki_name
|
||||
|
||||
# Set the wiki_url property
|
||||
if wiki_versioned_name is not None:
|
||||
wiki_url = wiki_page_name + "#" + wiki_versioned_name
|
||||
else:
|
||||
wiki_url = wiki_page_name
|
||||
|
||||
wiki_url = wiki_url.replace(" ", "_")
|
||||
self.monster_dict["wiki_url"] = "https://oldschool.runescape.wiki/w/" + wiki_url
|
||||
|
||||
# STAGE TWO: Extract, process and set monster properties from the infobox template
|
||||
|
||||
# Initialize a dictionary that maps proj_name -> prop_name
|
||||
# proj_name is used in this project
|
||||
# prop_name is used by the OSRS Wiki
|
||||
monster_properties = {"members": "members",
|
||||
"release_date": "release",
|
||||
"hitpoints": "hitpoints",
|
||||
"max_hit": "max hit",
|
||||
"attack_type": "attack style",
|
||||
"attack_speed": "attack speed",
|
||||
"aggressive": "aggressive",
|
||||
"poisonous": "poisonous",
|
||||
"venomous": "poisonous",
|
||||
"immune_poison": "immunepoison",
|
||||
"immune_venom": "immunevenom",
|
||||
"attributes": "attributes",
|
||||
"category": "cat",
|
||||
"slayer_level": "slaylvl",
|
||||
"slayer_xp": "slayxp",
|
||||
"examine": "examine"}
|
||||
|
||||
# Loop each of the combat bonuses and populate
|
||||
for proj_name, prop_name in monster_properties.items():
|
||||
value = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = prop_name + str(self.infobox_version_number)
|
||||
value = self.extract_infobox_value(self.template, key)
|
||||
|
||||
if value is None:
|
||||
value = self.extract_infobox_value(self.template, prop_name)
|
||||
|
||||
self.monster_dict[proj_name] = infobox_cleaner.caller(value, proj_name)
|
||||
|
||||
if value is None:
|
||||
self.monster_dict["incomplete"] = True
|
||||
|
||||
# Set slayer level to one, if slayer xp is given and
|
||||
# slayer level is None
|
||||
if self.monster_dict["slayer_xp"]:
|
||||
if self.monster_dict["slayer_level"] is None:
|
||||
self.monster_dict["slayer_level"] = 1
|
||||
|
||||
# SLAYER MONSTER: Determine if the monster can be a slayer task
|
||||
if self.monster_dict["slayer_xp"]:
|
||||
self.monster_dict["slayer_monster"] = True
|
||||
else:
|
||||
self.monster_dict["slayer_monster"] = False
|
||||
|
||||
# SLAYER MASTERS: Determine the slayer masters
|
||||
if self.monster_dict["slayer_monster"]:
|
||||
slayer_masters = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = "assignedby" + str(self.infobox_version_number)
|
||||
slayer_masters = self.extract_infobox_value(self.template, key)
|
||||
if slayer_masters is None:
|
||||
slayer_masters = self.extract_infobox_value(self.template, "assignedby")
|
||||
if slayer_masters is not None:
|
||||
self.monster_dict["slayer_masters"] = infobox_cleaner.slayer_masters(slayer_masters)
|
||||
else:
|
||||
self.monster_dict["slayer_masters"] = list()
|
||||
self.monster_dict["incomplete"] = True
|
||||
else:
|
||||
self.monster_dict["slayer_masters"] = list()
|
||||
|
||||
# MONSTER COMBAT BONUSES: Determine stats of the monster
|
||||
|
||||
# Initialize a dictionary that maps database_name -> property_name
|
||||
# The database_name is used in this project
|
||||
# The property_name is used by the OSRS Wiki
|
||||
combat_bonuses = {"attack_level": "att",
|
||||
"strength_level": "str",
|
||||
"defence_level": "def",
|
||||
"magic_level": "mage",
|
||||
"ranged_level": "range",
|
||||
"attack_bonus": "attbns",
|
||||
"strength_bonus": "strbns",
|
||||
"attack_magic": "amagic",
|
||||
"magic_bonus": "mbns",
|
||||
"attack_ranged": "arange",
|
||||
"ranged_bonus": "rngbns",
|
||||
"defence_stab": "dstab",
|
||||
"defence_slash": "dslash",
|
||||
"defence_crush": "dcrush",
|
||||
"defence_magic": "dmagic",
|
||||
"defence_ranged": "drange",
|
||||
}
|
||||
|
||||
# Loop each of the combat bonuses and populate
|
||||
for database_name, property_name in combat_bonuses.items():
|
||||
value = None
|
||||
if self.infobox_version_number is not None:
|
||||
key = property_name + str(self.infobox_version_number)
|
||||
value = self.extract_infobox_value(self.template, key)
|
||||
if value is None:
|
||||
value = self.extract_infobox_value(self.template, property_name)
|
||||
if value is not None:
|
||||
self.monster_dict[database_name] = infobox_cleaner.stats(value)
|
||||
else:
|
||||
self.monster_dict[database_name] = 0
|
||||
self.monster_dict["incomplete"] = True
|
||||
|
||||
# We finished processing, set incomplete to false if not true
|
||||
if not self.monster_dict.get("incomplete"):
|
||||
self.monster_dict["incomplete"] = False
|
||||
|
||||
def extract_infobox_value(self, template: mwparserfromhell.nodes.template.Template, key: str) -> str:
|
||||
"""Helper method to extract a value from a template using a specified key.
|
||||
|
||||
This helper method is a simple solution to repeatedly try to fetch a specific
|
||||
entry from a wiki text template (a mwparserfromhell template object).
|
||||
|
||||
:param template: A mediawiki wiki text template.
|
||||
:param key: The key to query in the template.
|
||||
:return value: The extracted template value based on supplied key.
|
||||
"""
|
||||
value = None
|
||||
try:
|
||||
value = template.get(key).value
|
||||
value = value.strip()
|
||||
return value
|
||||
except ValueError:
|
||||
return value
|
||||
|
||||
def check_duplicate_monster(self) -> MonsterProperties:
|
||||
"""Determine if this is a duplicate monster.
|
||||
|
||||
:return: A MonsterProperties object.
|
||||
"""
|
||||
# Start by setting the duplicate property to False
|
||||
self.monster_dict["duplicate"] = False
|
||||
|
||||
# Check/set last update
|
||||
last_update = self.all_db_monsters.get(self.monster_id, None)
|
||||
if last_update:
|
||||
self.monster_dict["last_updated"] = self.all_db_monsters[self.monster_id]["last_updated"]
|
||||
else:
|
||||
self.monster_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
|
||||
# Create an MonsterProperties object
|
||||
monster_properties = MonsterProperties(**self.monster_dict)
|
||||
|
||||
# Set the monster properties that we want to compare
|
||||
correlation_properties = {
|
||||
"wiki_name": False,
|
||||
"combat_level": False,
|
||||
"members": False
|
||||
}
|
||||
|
||||
# Loop the list of currently (already processed) monsters
|
||||
for known_monster in self.known_monsters:
|
||||
# Do a quick name check before deeper inspection
|
||||
if monster_properties.name != known_monster.name:
|
||||
continue
|
||||
|
||||
# If the cache names are equal, do further inspection
|
||||
for cprop in correlation_properties:
|
||||
if getattr(monster_properties, cprop) == getattr(known_monster, cprop):
|
||||
correlation_properties[cprop] = True
|
||||
|
||||
# Check is all values in correlation properties are True
|
||||
correlation_result = all(value is True for value in correlation_properties.values())
|
||||
if correlation_result:
|
||||
self.monster_dict["duplicate"] = True
|
||||
|
||||
return monster_properties
|
||||
|
||||
def populate_monster_drops(self):
|
||||
"""Set the monster drops from preprocessed data."""
|
||||
try:
|
||||
self.monster_dict["drops"] = self.monsters_drops[self.monster_id]
|
||||
except KeyError:
|
||||
self.monster_dict["drops"] = []
|
||||
|
||||
def compare_new_vs_old_monster(self):
|
||||
"""Diff this monster and the monster that exists in the database."""
|
||||
# Create JSON out object to compare
|
||||
self.monster_properties = MonsterProperties(**self.monster_dict)
|
||||
current_json = self.monster_properties.construct_json()
|
||||
|
||||
# Try get existing entry (KeyError means it doesn't exist - aka a new monster)
|
||||
try:
|
||||
existing_json = self.all_db_monsters[self.monster_id]
|
||||
except KeyError:
|
||||
print(f">>> compare_json_files: NEW MONSTER: {self.monster_properties.id}")
|
||||
print(current_json)
|
||||
self.monster_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
return
|
||||
|
||||
# Quick check of eqaulity, return if properties and drops are the same
|
||||
if current_json == existing_json:
|
||||
self.monster_dict["last_updated"] = self.all_db_monsters[self.monster_id]["last_updated"]
|
||||
return
|
||||
|
||||
# Print a header for the changed monster
|
||||
print(f">>> compare_json_files: CHANGED MONSTER: {self.monster_properties.id}: {self.monster_properties.name}")
|
||||
|
||||
# First check the base properties
|
||||
ddiff_props = DeepDiff(existing_json, current_json, ignore_order=True)
|
||||
if ddiff_props:
|
||||
print(ddiff_props)
|
||||
|
||||
self.monster_dict["last_updated"] = datetime.now(timezone.utc).strftime("%Y-%m-%d")
|
||||
|
||||
def export_monster_to_json(self):
|
||||
"""Export monster to JSON, if requested."""
|
||||
self.monster_properties = MonsterProperties(**self.monster_dict)
|
||||
output_dir = Path(config.DOCS_PATH, "monsters-json")
|
||||
self.monster_properties.export_json(True, output_dir)
|
||||
|
||||
def validate_monster(self):
|
||||
"""Use the schema-monsters.json file to validate the populated monster."""
|
||||
# Create JSON out object to validate
|
||||
self.monster_properties = MonsterProperties(**self.monster_dict)
|
||||
current_json = self.monster_properties.construct_json()
|
||||
|
||||
# Validate object with schema attached
|
||||
v = validator.MyValidator(self.schema_data)
|
||||
v.validate(current_json)
|
||||
|
||||
# Print any validation errors
|
||||
if v.errors:
|
||||
print(v.errors)
|
||||
exit(1)
|
||||
|
||||
assert v.validate(current_json)
|
||||
165
builders/monsters/builder.py
Normal file
165
builders/monsters/builder.py
Normal file
|
|
@ -0,0 +1,165 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Program to invoke monster database generation process.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import argparse
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from builders.monsters import build_monster
|
||||
|
||||
|
||||
class Builder:
|
||||
def __init__(self, **kwargs):
|
||||
# Set properties to control phases of build
|
||||
self.verbose = kwargs["verbose"]
|
||||
self.compare = kwargs["compare"]
|
||||
self.export = kwargs["export"]
|
||||
self.validate = kwargs["validate"]
|
||||
|
||||
# Load the raw cache data that has been processed (this is ground truth)
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-cache-data.json")) as f:
|
||||
self.all_monster_cache_data = json.load(f)
|
||||
|
||||
# Load all monster data (from min JSON file)
|
||||
# with open(Path(config.DOCS_PATH / "monsters-complete.json")) as f:
|
||||
# self.all_db_monsters = json.load(f)
|
||||
self.all_db_monsters = dict()
|
||||
|
||||
# Load the monster wikitext file of page text
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-text.json")) as f:
|
||||
self.all_wikitext_raw = json.load(f)
|
||||
|
||||
# Load the monster wikitext file of processed data
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-text-processed.json")) as f:
|
||||
self.all_wikitext_processed = json.load(f)
|
||||
|
||||
# Load the monster processed monster drops
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-drops.json")) as f:
|
||||
self.monsters_drops = json.load(f)
|
||||
|
||||
# Load schema data
|
||||
with open(Path(config.DATA_SCHEMAS_PATH / "schema-monsters.json")) as f:
|
||||
self.schema_data = json.load(f)
|
||||
|
||||
# Initialize a list of known monsters
|
||||
self.known_monsters = list()
|
||||
|
||||
def run(self):
|
||||
# Start processing every monster!
|
||||
for monster_id in self.all_monster_cache_data:
|
||||
|
||||
# if int(monster_id) < 11000:
|
||||
# continue
|
||||
|
||||
# Initialize the BuildMonster class, used for all monsters
|
||||
builder = build_monster.BuildMonster(monster_id=monster_id,
|
||||
all_monster_cache_data=self.all_monster_cache_data,
|
||||
all_db_monsters=self.all_db_monsters,
|
||||
all_wikitext_raw=self.all_wikitext_raw,
|
||||
all_wikitext_processed=self.all_wikitext_processed,
|
||||
monsters_drops=self.monsters_drops,
|
||||
schema_data=self.schema_data,
|
||||
known_monsters=self.known_monsters,
|
||||
verbose=self.verbose)
|
||||
|
||||
status = builder.preprocessing()
|
||||
if status:
|
||||
builder.populate_monster()
|
||||
known_monster = builder.check_duplicate_monster()
|
||||
self.known_monsters.append(known_monster)
|
||||
builder.populate_monster_drops()
|
||||
if self.compare:
|
||||
builder.compare_new_vs_old_monster()
|
||||
if self.export:
|
||||
builder.export_monster_to_json()
|
||||
if self.validate:
|
||||
builder.validate_monster()
|
||||
|
||||
# Done processing, rejoice!
|
||||
print("Built.")
|
||||
exit(0)
|
||||
|
||||
def test(self):
|
||||
# Start processing every monster!
|
||||
for monster_id in self.all_monster_cache_data:
|
||||
|
||||
# if int(monster_id) < 10000:
|
||||
# continue
|
||||
|
||||
# Initialize the BuildMonster class, used for all monsters
|
||||
builder = build_monster.BuildMonster(monster_id=monster_id,
|
||||
all_monster_cache_data=self.all_monster_cache_data,
|
||||
all_db_monsters=self.all_db_monsters,
|
||||
all_wikitext_raw=self.all_wikitext_raw,
|
||||
all_wikitext_processed=self.all_wikitext_processed,
|
||||
monsters_drops=self.monsters_drops,
|
||||
schema_data=self.schema_data,
|
||||
known_monsters=self.known_monsters,
|
||||
verbose=self.verbose)
|
||||
|
||||
status = builder.preprocessing()
|
||||
if status:
|
||||
builder.populate_monster()
|
||||
known_monster = builder.check_duplicate_monster()
|
||||
self.known_monsters.append(known_monster)
|
||||
builder.populate_monster_drops()
|
||||
builder.validate_monster()
|
||||
|
||||
# Done testing, rejoice!
|
||||
print("Tested.")
|
||||
exit(0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(description="Build monster database.")
|
||||
parser.add_argument('--verbose',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to be verbose.')
|
||||
parser.add_argument('--compare',
|
||||
default=True,
|
||||
required=False,
|
||||
help='A boolean of whether to compare data.')
|
||||
parser.add_argument('--export',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to export data.')
|
||||
parser.add_argument('--validate',
|
||||
default=True,
|
||||
required=False,
|
||||
help='A boolean of whether to validate using schema.')
|
||||
parser.add_argument('--test',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to test the builder process.')
|
||||
args = parser.parse_args()
|
||||
|
||||
builder = Builder(verbose=args.verbose,
|
||||
compare=args.compare,
|
||||
export=args.export,
|
||||
validate=args.validate)
|
||||
if args.test:
|
||||
builder.test()
|
||||
else:
|
||||
builder.run()
|
||||
431
builders/monsters/infobox_cleaner.py
Normal file
431
builders/monsters/infobox_cleaner.py
Normal file
|
|
@ -0,0 +1,431 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Various methods to help clean OSRS Wiki wikitext entries.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import re
|
||||
|
||||
import dateparser
|
||||
|
||||
|
||||
def clean_wikitext(value: str) -> str:
|
||||
"""Generic infobox property cleaner.
|
||||
|
||||
This helper method is a generic cleaner for all infobox template properties.
|
||||
The value is string cast, stipped of new line characters, then any square
|
||||
brackets (wikitext links) are stripped, then anything in trailing brackets,
|
||||
then any HTML line breaks are removed.
|
||||
|
||||
:param value: Template value extracted in raw wikitext format.
|
||||
:return value: Cleaned template value.
|
||||
"""
|
||||
value = str(value)
|
||||
value = value.strip()
|
||||
value = re.sub(r'[\[\]]+', '', value) # Removes all "[" and "]"
|
||||
value = re.sub(r' \([^()]*\)', '', value) # Removes " (anything)"
|
||||
value = re.sub(r'<!--(.*?)-->', '', value) # Removes "<!--anything-->"
|
||||
value = re.sub(r'<br(.*)', '', value) # Removes "<br"
|
||||
return value
|
||||
|
||||
|
||||
def caller(value: str, prop: str):
|
||||
"""Calls specific function based on property name.
|
||||
|
||||
Since there is a dict loop method to reduce code duplication,
|
||||
there needs to be a way to call the function that matches the
|
||||
property. This helps call the function and return the cleaned
|
||||
values.
|
||||
|
||||
:param value: Template value extracted in raw wikitext format.
|
||||
:param prop: The template property being processed.
|
||||
:return value: Cleaned template value.
|
||||
"""
|
||||
value = globals()[prop](value)
|
||||
return value
|
||||
|
||||
|
||||
def members(value: str) -> bool:
|
||||
"""Convert the members property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: Template value converted into a boolean.
|
||||
"""
|
||||
if value.lower() in ["true", "yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def release_date(value: str) -> str:
|
||||
"""Convert the release date entry to an ISO 8601 date str.
|
||||
|
||||
From the wiki, the usual date format is: dd Month YYYY
|
||||
But it will have wikitext markup: [[31 October]] [[2005]]
|
||||
Returned value is ISO 8601 date string: YYYY-MM-DD
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned release date in ISO 8601 date format.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
value = value.replace("[", "").replace("]", "")
|
||||
print(value)
|
||||
|
||||
try:
|
||||
return dateparser.parse(value).date().isoformat()
|
||||
except (ValueError, AttributeError):
|
||||
return None
|
||||
|
||||
|
||||
def hitpoints(value: str) -> int:
|
||||
"""Convert the hitpoints entry to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned hitpoints value as an integer.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def max_hit(value: str) -> int:
|
||||
"""Convert the max_hit entry to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned max_hit value as an integer.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
value = re.split("[ ,]", value)[0]
|
||||
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def attack_type(value: str) -> list:
|
||||
"""Convert the attack type entry to a list of strings.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:return value: A cleaned attack_type value as a list of strings.
|
||||
"""
|
||||
value_list = []
|
||||
|
||||
if value is None or value == "":
|
||||
return value_list
|
||||
|
||||
value = value.lower()
|
||||
value = value.replace("[", "").replace("]", "")
|
||||
|
||||
# Check for specific attack type strings...
|
||||
if "melee" in value:
|
||||
value_list.append("melee")
|
||||
if "slash" in value:
|
||||
value_list.append("slash")
|
||||
if "crush" in value:
|
||||
value_list.append("crush")
|
||||
if "stab" in value:
|
||||
value_list.append("stab")
|
||||
if "ranged" in value:
|
||||
value_list.append("ranged")
|
||||
if "magic" in value:
|
||||
value_list.append("magic")
|
||||
if "typeless" in value:
|
||||
value_list.append("typeless")
|
||||
if "dragonfire" in value:
|
||||
value_list.append("dragonfire")
|
||||
|
||||
return value_list
|
||||
|
||||
|
||||
def attack_speed(value: str) -> int:
|
||||
"""Convert the attack_speed entry to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned attack_speed value as an integer.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def aggressive(value: str) -> bool:
|
||||
"""Convert the aggressive property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned aggressive value as a boolean.
|
||||
"""
|
||||
value = clean_wikitext(value)
|
||||
|
||||
if value.lower() in ["true", "yes"]:
|
||||
return True
|
||||
elif value.split(" ")[0].lower in ["true", "yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def poisonous(value: str) -> bool:
|
||||
"""Convert the poisonous property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned poisonous value as a boolean.
|
||||
"""
|
||||
if not value:
|
||||
return False
|
||||
|
||||
value = clean_wikitext(value)
|
||||
|
||||
if value.lower() in ["true", "yes"]:
|
||||
return True
|
||||
elif value.split(" ")[0].lower in ["true", "yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def venomous(value: str) -> bool:
|
||||
"""Convert the venomous property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned venomous value as a boolean.
|
||||
"""
|
||||
if not value:
|
||||
return False
|
||||
|
||||
if "venom" in value.lower():
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def immune_poison(value: str) -> bool:
|
||||
"""Convert the immune_poison property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned immune_poison value as a boolean.
|
||||
"""
|
||||
if not value:
|
||||
return False
|
||||
|
||||
if value.lower() in ["true", "yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def immune_venom(value: str) -> bool:
|
||||
"""Convert the immune_venom property to a boolean.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned immune_venom value as a boolean.
|
||||
"""
|
||||
if not value:
|
||||
return False
|
||||
|
||||
if value.lower() in ["true", "yes"]:
|
||||
return True
|
||||
else:
|
||||
return False
|
||||
|
||||
|
||||
def attributes(value: str) -> str:
|
||||
"""Convert the attributes text entry to a list.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned attributes value as a list.
|
||||
"""
|
||||
attributes_list = list()
|
||||
|
||||
if value is None or value == "":
|
||||
return attributes_list
|
||||
|
||||
value = value.lower()
|
||||
|
||||
# Check for specific melee attack types
|
||||
if "demon" in value:
|
||||
attributes_list.append("demon")
|
||||
if "dragon" in value:
|
||||
attributes_list.append("dragon")
|
||||
if "fiery" in value:
|
||||
attributes_list.append("fiery")
|
||||
if "golem" in value:
|
||||
attributes_list.append("golem")
|
||||
if "kalphite" in value:
|
||||
attributes_list.append("kalphite")
|
||||
if "leafy" in value:
|
||||
attributes_list.append("leafy")
|
||||
if "penance" in value:
|
||||
attributes_list.append("penance")
|
||||
if "shade" in value:
|
||||
attributes_list.append("shade")
|
||||
if "spectral" in value:
|
||||
attributes_list.append("spectral")
|
||||
if "undead" in value:
|
||||
attributes_list.append("undead")
|
||||
if "vampyre" in value:
|
||||
attributes_list.append("vampyre")
|
||||
if "xerician" in value:
|
||||
attributes_list.append("xerician")
|
||||
|
||||
return attributes_list
|
||||
|
||||
|
||||
def category(value: str) -> str:
|
||||
"""Convert the category text entry from an OSRS Wiki infobox.
|
||||
|
||||
:param value: The extracted raw wiki text.
|
||||
:return: A cleaned categories property value.
|
||||
"""
|
||||
category_list = list()
|
||||
|
||||
if value is None or value == "" or value.lower() == "no" or "<!--" in value:
|
||||
return category_list
|
||||
|
||||
value = clean_wikitext(value)
|
||||
|
||||
value = value.lower()
|
||||
|
||||
value = value.replace("dagannoths", "dagannoth")
|
||||
|
||||
if "|" in value:
|
||||
value = value.split("|")[1]
|
||||
|
||||
value_list = None
|
||||
if "," in value:
|
||||
value_list = list()
|
||||
for v in value.split(","):
|
||||
v = v.strip()
|
||||
value_list.append(v)
|
||||
|
||||
if value_list:
|
||||
for value in value_list:
|
||||
category_list.append(value)
|
||||
else:
|
||||
category_list.append(value)
|
||||
|
||||
return category_list
|
||||
|
||||
|
||||
def slayer_level(value: str) -> int:
|
||||
"""Convert the slayer_level entry to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned slayer_level value as an integer.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def slayer_xp(value: str) -> float:
|
||||
"""Convert the slayer_xp entry to a float.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned slayer_xp value as a float.
|
||||
"""
|
||||
if not value:
|
||||
return None
|
||||
|
||||
value = clean_wikitext(value)
|
||||
|
||||
try:
|
||||
return float(value)
|
||||
except ValueError:
|
||||
return None
|
||||
|
||||
|
||||
def slayer_masters(value: str) -> float:
|
||||
"""Convert the slayer_masters entry to a list.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned slayer_masters value as a list.
|
||||
"""
|
||||
slayer_masters = value.strip()
|
||||
|
||||
if slayer_masters.lower().startswith("no") or slayer_masters == "":
|
||||
return list()
|
||||
|
||||
# Split string into list of strings
|
||||
slayer_masters = slayer_masters.split(",")
|
||||
slayer_masters = [x.strip() for x in slayer_masters]
|
||||
slayer_masters = [x.lower() for x in slayer_masters]
|
||||
|
||||
# Remove Steve, just for consistency
|
||||
if "steve" in slayer_masters:
|
||||
slayer_masters.remove("steve")
|
||||
if "nieve" not in slayer_masters:
|
||||
slayer_masters.append("nieve")
|
||||
|
||||
return slayer_masters
|
||||
|
||||
|
||||
def examine(value: str) -> bool:
|
||||
"""Convert the examine entry to a list.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned examine value as a str.
|
||||
"""
|
||||
value = clean_wikitext(value)
|
||||
|
||||
# Quick fix for multiline examine texts
|
||||
value = value.split("\n")[0]
|
||||
|
||||
# Remove: brackets, curly braces, spaces, tidle, plus
|
||||
value = re.sub(r'[{}\*"]', '', value)
|
||||
|
||||
# Change: three periods style
|
||||
value = value.replace("…", "...")
|
||||
|
||||
# Remove: versioned examine text markers
|
||||
value = re.sub(r"'{2,}[^']+[']*", '', value)
|
||||
|
||||
# Finally, strip any remaining whitespace
|
||||
value = value.strip()
|
||||
|
||||
return value
|
||||
|
||||
|
||||
def stats(value: str) -> int:
|
||||
"""Convert a monster stat value to an integer.
|
||||
|
||||
:param value: Template value extracted from raw wikitext.
|
||||
:return value: A cleaned stat value as an int.
|
||||
"""
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return 0
|
||||
60
config.py
Normal file
60
config.py
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Global project configurations including project path constants and
|
||||
Cerberus validator configuration.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from pathlib import Path
|
||||
|
||||
PROJECT_ROOT_PATH = Path(__file__).parent
|
||||
|
||||
# Top level directories
|
||||
BUILDERS_PATH = Path(PROJECT_ROOT_PATH / "builders")
|
||||
DATA_PATH = Path(PROJECT_ROOT_PATH / "data")
|
||||
DOCS_PATH = Path(PROJECT_ROOT_PATH / "docs")
|
||||
PACKAGE_PATH = Path(PROJECT_ROOT_PATH / "osrsbox")
|
||||
SCRIPTS_PATH = Path(PROJECT_ROOT_PATH / "scripts")
|
||||
TEST_PATH = Path(PROJECT_ROOT_PATH / "test")
|
||||
STATICS_PATH = Path(PROJECT_ROOT_PATH / "statics")
|
||||
|
||||
# Useful data paths
|
||||
DATA_CACHE_PATH = Path(DATA_PATH / "cache")
|
||||
DATA_WIKI_PATH = Path(DATA_PATH / "wiki")
|
||||
DATA_ICONS_PATH = Path(DATA_PATH / "icons")
|
||||
DATA_ITEMS_PATH = Path(DATA_PATH / "items")
|
||||
DATA_MONSTERS_PATH = Path(DATA_PATH / "monsters")
|
||||
DATA_SCHEMAS_PATH = Path(DATA_PATH / "schemas")
|
||||
|
||||
# Useful builder paths
|
||||
BUILDERS_ITEMS = Path(BUILDERS_PATH / "items")
|
||||
BUILDERS_MONSTERS = Path(BUILDERS_PATH / "monsters")
|
||||
|
||||
# Useful scripts paths
|
||||
SCRIPTS_ITEMS = Path(SCRIPTS_PATH / "items")
|
||||
SCRIPTS_MONSTERS = Path(SCRIPTS_PATH / "monsters")
|
||||
SCRIPTS_SCHEMAS = Path(SCRIPTS_PATH / "schemas")
|
||||
SCRIPTS_UPDATE = Path(SCRIPTS_PATH / "update")
|
||||
|
||||
# User agent for wiki scraping requests
|
||||
custom_agent = {
|
||||
'User-Agent': "osrsbox - @PH01L#7906",
|
||||
'From': "phoil@osrsbox.com"
|
||||
}
|
||||
106
justfile
Normal file
106
justfile
Normal file
|
|
@ -0,0 +1,106 @@
|
|||
all: pull-all cache-update data builders_test builders_run (update "True" "True")
|
||||
|
||||
pull-all:
|
||||
# git pull
|
||||
git submodule update --recursive --remote
|
||||
|
||||
cache-update: pull-all flatcache runelite
|
||||
|
||||
flatcache: pull-all
|
||||
#!/usr/bin/env bash
|
||||
root=$(git rev-parse --show-toplevel)
|
||||
echo 'flatcache'
|
||||
echo 'building-flatcache'
|
||||
cd data/cache/osrs-flatcache
|
||||
mvn clean && mvn install -Dcheckstyle.skip=false
|
||||
cd packer/target
|
||||
jar_file=$(ls | grep .shaded.jar)
|
||||
echo 'extracting cache'
|
||||
rm -r "${root}/data/cache/cache-data"
|
||||
mkdir -p "${root}/data/cache/cache-data"
|
||||
java -jar "${jar_file}" unpack "${root}/data/cache/osrs-cache" "${root}/data/cache/cache-data"
|
||||
|
||||
runelite: flatcache
|
||||
#!/usr/bin/env bash
|
||||
root=$(git rev-parse --show-toplevel)
|
||||
rl=$(echo "${root}/runelite")
|
||||
echo "runelite"
|
||||
cd "${rl}"
|
||||
git pull
|
||||
|
||||
echo "Installing custom plugins"
|
||||
cp -R "${root}/rl-plugins/*" "${rl}/runelite-client/src/main/java/net/runelite/client/plugins/"
|
||||
|
||||
echo "Building RuneLite..."
|
||||
mvn clean
|
||||
mvn install -DskipTests
|
||||
|
||||
# Find the cache.jar file with current version and bundled with dependencies
|
||||
# For example: cache-1.5.27-SNAPSHOT-jar-with-dependencies.jar
|
||||
cd "${rl}/cache/target"
|
||||
jar_file=$(ls | grep .jar-with-dependencies.)
|
||||
|
||||
# Remove old cache dumps
|
||||
echo -e " > Removing the old cache dump in osrsbox-db..."
|
||||
rm -r "${root}/data/cache/items/"
|
||||
rm -r "${root}/data/cache/npcs/"
|
||||
rm -r "${root}/data/cache/objects/"
|
||||
|
||||
# Dump the cache
|
||||
echo -e " > Dumping cache using RuneLite cache tool..."
|
||||
java -classpath "${jar_file}" net.runelite.cache.Cache \
|
||||
-cache "${root}/data/cache/cache-data" \
|
||||
-items "${root}/data/cache/items"
|
||||
|
||||
java -classpath "${jar_file}" net.runelite.cache.Cache \
|
||||
-cache "${root}/data/cache/cache-data" \
|
||||
-npcs "${root}/data/cache/npcs"
|
||||
|
||||
java -classpath "${jar_file}" net.runelite.cache.Cache \
|
||||
-cache "${root}/data/cache/cache-data" \
|
||||
-objects "${root}/data/cache/objects"
|
||||
|
||||
echo "Run runelite, log in, and configure the metadatadumper. run ::item. There are about 27k items now"
|
||||
echo "TODO: MAKE THIS AUTOMATED. \$rl/cache/src/main/java/net/runelite/cache/Cache.java has a main function"
|
||||
|
||||
data: (poetry "install")
|
||||
#!/usr/bin/env bash
|
||||
root=$(git rev-parse --show-toplevel)
|
||||
poetry install
|
||||
|
||||
poetry run python -m scripts.cache.update
|
||||
|
||||
poetry run python -m scripts.icons.convert_item_icons
|
||||
|
||||
poetry run python -m scripts.items.update
|
||||
|
||||
poetry run python -m scripts.monsters.update
|
||||
|
||||
builders_test: (poetry "install")
|
||||
#!/usr/bin/env bash
|
||||
set -x
|
||||
poetry run python -m builders.items.builder --test=True
|
||||
poetry run python -m builders.monsters.builder --test=True
|
||||
|
||||
builders_run: (poetry "install") builders_test
|
||||
#!/usr/bin/env bash
|
||||
set -x
|
||||
poetry run python -m builders.items.builder --export=True
|
||||
poetry run python -m builders.monsters.builder --export=True
|
||||
|
||||
update monsters items: (pipx "poetry") data builders_run
|
||||
#!/usr/bin/env bash
|
||||
poetry run python -m scripts.update.update_json_files --monsters={{monsters}} --items={{items}}
|
||||
|
||||
poetry action: (pipx "poetry")
|
||||
poetry {{action}}
|
||||
|
||||
pipx package_to_install:
|
||||
pipx install {{ package_to_install }}
|
||||
|
||||
monsters:
|
||||
PYTHONPATH="." python scripts/monsters/update.py
|
||||
PYTHONPATH="." python builders/monsters/builder.py --test=True
|
||||
PYTHONPATH="." python builders/monsters/builder.py --export=True
|
||||
PYTHONPATH="." python scripts/update/update_json_files.py --monster=True
|
||||
cp docs/monsters-complete.json monsters-complete.json
|
||||
1
osrsbox/__init__.py
Normal file
1
osrsbox/__init__.py
Normal file
|
|
@ -0,0 +1 @@
|
|||
__version__ = "2.2.3"
|
||||
1
osrsbox/docs/items-complete.json
Normal file
1
osrsbox/docs/items-complete.json
Normal file
File diff suppressed because one or more lines are too long
1
osrsbox/docs/monsters-complete.json
Normal file
1
osrsbox/docs/monsters-complete.json
Normal file
File diff suppressed because one or more lines are too long
1
osrsbox/docs/prayers-complete.json
Normal file
1
osrsbox/docs/prayers-complete.json
Normal file
File diff suppressed because one or more lines are too long
29
osrsbox/items_api/__init__.py
Normal file
29
osrsbox/items_api/__init__.py
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from osrsbox.items_api import all_items
|
||||
|
||||
|
||||
def load() -> all_items.AllItems:
|
||||
"""Load the item database.
|
||||
|
||||
:return all_db_items: An AllItems object containing the entire item database.
|
||||
"""
|
||||
return all_items.AllItems()
|
||||
200
osrsbox/items_api/all_items.py
Normal file
200
osrsbox/items_api/all_items.py
Normal file
|
|
@ -0,0 +1,200 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Union, Generator
|
||||
|
||||
from osrsbox.items_api.item_properties import ItemProperties
|
||||
|
||||
PATH_TO_ITEMS_COMPLETE_JSON = Path(__file__).absolute().parent / ".." / ".." / "docs" / "items-complete.json"
|
||||
if not PATH_TO_ITEMS_COMPLETE_JSON.is_file():
|
||||
PATH_TO_ITEMS_COMPLETE_JSON = Path(__file__).absolute().parent / ".." / "docs" / "items-complete.json"
|
||||
if not PATH_TO_ITEMS_COMPLETE_JSON.is_file():
|
||||
raise ValueError("Error: Default item database file not found. Exiting")
|
||||
|
||||
|
||||
class AllItems:
|
||||
"""This class handles loading of the osrsbox-db items database.
|
||||
|
||||
:param input_data_file_or_directory: The osrsbox-db items folder of JSON files, or single JSON file.
|
||||
"""
|
||||
def __init__(self, input_data_file_or_directory: Path = PATH_TO_ITEMS_COMPLETE_JSON):
|
||||
self.all_items: List[ItemProperties] = list()
|
||||
self.all_items_dict: Dict[int, ItemProperties] = dict()
|
||||
self.load_all_items(input_data_file_or_directory)
|
||||
|
||||
def __iter__(self) -> Generator[ItemProperties, None, None]:
|
||||
"""Iterate (loop) over each ItemProperties object."""
|
||||
for item in self.all_items:
|
||||
yield item
|
||||
|
||||
def __getitem__(self, id_number: int) -> ItemProperties:
|
||||
"""Return the item definition object for a loaded item.
|
||||
|
||||
:param id_number: The item ID number.
|
||||
:return: The item definition object linked to a specific ID number.
|
||||
"""
|
||||
return self.all_items_dict[id_number]
|
||||
|
||||
def __len__(self) -> int:
|
||||
"""Return the count of the total number of items.
|
||||
|
||||
:return: The total number of items.
|
||||
"""
|
||||
return len(self.all_items)
|
||||
|
||||
def lookup_by_item_id(self, item_id_number: int) -> ItemProperties:
|
||||
"""Lookup a specific item ID and get the associated ItemProperties object.
|
||||
|
||||
:param item_id_number: The item ID to lookup.
|
||||
:return: The ItemProperties object found from the lookup.
|
||||
:raises: KeyError when the item ID cannot be found.
|
||||
"""
|
||||
try:
|
||||
item_properties = self.all_items_dict[item_id_number]
|
||||
except KeyError:
|
||||
raise KeyError("Cannot find the provided item ID number...")
|
||||
return item_properties
|
||||
|
||||
def lookup_by_item_name(self, item_name: str, use_wiki_name: bool = False) -> ItemProperties:
|
||||
"""Lookup a specific item name and get the associated ItemProperties object.
|
||||
|
||||
This function performs a lookup on all items in the database. The property
|
||||
that is queried is the item name, or the `wiki_name` if specified in the
|
||||
method parameters. The only transformation performed on the item name
|
||||
provided is to convert it to lower case to (slightly) improve lookup recall.
|
||||
This function works on a first-come-first-served basis. The first instance
|
||||
where the name matches is returned.
|
||||
|
||||
:param item_name: The item name to lookup.
|
||||
:param use_wiki_name: Whether to use the `wiki_name` instead of `name`.
|
||||
:return: The ItemProperties object found from the lookup.
|
||||
:raises: ValueError when the item name cannot be found.
|
||||
"""
|
||||
# Set the property value
|
||||
lookup_property = "name"
|
||||
if use_wiki_name:
|
||||
lookup_property = "wiki_name"
|
||||
|
||||
for item in self.all_items:
|
||||
# Get the raw property value
|
||||
name_value = getattr(item, lookup_property)
|
||||
# Check property value for None (only effective for wiki_name)
|
||||
if not name_value:
|
||||
continue
|
||||
|
||||
# Check for an exact name match
|
||||
if name_value.lower() == item_name.lower():
|
||||
return item
|
||||
|
||||
raise ValueError("Cannot find the provided item name...")
|
||||
|
||||
def search_item_names(self, keyword: str) -> List[ItemProperties]:
|
||||
"""Keyword search items and get the a list of ItemProperties objects.
|
||||
|
||||
This function performs a search of all item names in the database. The name
|
||||
and wiki_name properties are searched. Results are returned as a list of
|
||||
ItemProperties objects. The only transformation performed is converting the
|
||||
search keyword and item name/wiki_name to lower case.
|
||||
|
||||
:param keyword: The keyword to search for.
|
||||
:return: A list of ItemProperties objects found from the keyword search.
|
||||
:raises: ValueError when no keyword matches can be found.
|
||||
"""
|
||||
item_results = list()
|
||||
for item in self.all_items:
|
||||
if keyword.lower() in item.name.lower():
|
||||
item_results.append(item)
|
||||
elif item.wiki_name:
|
||||
if keyword.lower() in item.wiki_name.lower():
|
||||
item_results.append(item)
|
||||
|
||||
return item_results
|
||||
|
||||
def load_all_items(self, input_data_file_or_directory: Union[Path, str]) -> None:
|
||||
"""Load the items database via a JSON file, or directory of JSON files.
|
||||
|
||||
:param input_data_file_or_directory: The path to the data input.
|
||||
:raises ValueError: Valid input not found.
|
||||
"""
|
||||
# Check if a str is supplied, if so, convert to Path object
|
||||
if isinstance(input_data_file_or_directory, str):
|
||||
input_data_file_or_directory = Path(input_data_file_or_directory)
|
||||
|
||||
# Process the directory of JSON, or a single JSON file
|
||||
if input_data_file_or_directory.is_dir():
|
||||
self._load_items_from_directory(path_to_directory=input_data_file_or_directory)
|
||||
elif input_data_file_or_directory.is_file():
|
||||
self._load_items_from_file(path_to_json_file=input_data_file_or_directory)
|
||||
else:
|
||||
raise ValueError("Error: Valid input not found. Exiting.")
|
||||
|
||||
# Sort the list of items
|
||||
self.all_items.sort(key=lambda x: x.id)
|
||||
|
||||
def _load_items_from_directory(self, path_to_directory: Path) -> None:
|
||||
"""Load item database from a directory of JSON files (`items-json`).
|
||||
|
||||
:param path_to_directory: The path to the `items-json` directory.
|
||||
:raises ValueError: No JSON files found in supplied directory.
|
||||
"""
|
||||
# Fetch all .json files in provided dir
|
||||
json_files = list(path_to_directory.glob("*.json"))
|
||||
|
||||
try:
|
||||
json_files[0]
|
||||
except IndexError as e:
|
||||
raise ValueError("Error: No files found in directory, check the supplied path. Exiting.") from e
|
||||
|
||||
# Loop through every item in JSON file
|
||||
for json_file in json_files:
|
||||
with open(json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
self._load_item(temp)
|
||||
|
||||
def _load_items_from_file(self, path_to_json_file: Path) -> None:
|
||||
"""Load item database from a single JSON file (`items-complete.json`).
|
||||
|
||||
:param path_to_json_file: The path to the `items-complete.json` file.
|
||||
"""
|
||||
with open(path_to_json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
for entry in temp:
|
||||
self._load_item(temp[entry])
|
||||
|
||||
def _load_item(self, item_json: Dict) -> None:
|
||||
"""Convert the `item_json` into a :class:`ItemProperties` and store it.
|
||||
|
||||
:param item_json: A dict from an open and loaded JSON file.
|
||||
:raises ValueError: Cannot populate item.
|
||||
"""
|
||||
# Load the item using the ItemProperties class
|
||||
try:
|
||||
item_def = ItemProperties.from_json(item_json)
|
||||
except TypeError as e:
|
||||
raise ValueError("Error: Invalid JSON structure found, check supplied input. Exiting") from e
|
||||
|
||||
# Add item to list
|
||||
self.all_items.append(item_def)
|
||||
self.all_items_dict[item_def.id] = item_def
|
||||
58
osrsbox/items_api/item_equipment.py
Normal file
58
osrsbox/items_api/item_equipment.py
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from dataclasses import asdict
|
||||
from dataclasses import dataclass
|
||||
from typing import Dict
|
||||
from typing import Optional
|
||||
|
||||
|
||||
@dataclass
|
||||
class ItemEquipment:
|
||||
"""This class defines the properties for an equipable OSRS item.
|
||||
|
||||
The ItemEquipment class is the object that retains all items properties related
|
||||
to equipable items. This includes item stats (attack, defence bonuses) and
|
||||
additional properties about equipment slot, attack speed and skill requirements
|
||||
for the item.
|
||||
"""
|
||||
attack_stab: int
|
||||
attack_slash: int
|
||||
attack_crush: int
|
||||
attack_magic: int
|
||||
attack_ranged: int
|
||||
defence_stab: int
|
||||
defence_slash: int
|
||||
defence_crush: int
|
||||
defence_magic: int
|
||||
defence_ranged: int
|
||||
melee_strength: int
|
||||
ranged_strength: int
|
||||
magic_damage: int
|
||||
prayer: int
|
||||
slot: str
|
||||
requirements: Optional[Dict]
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary/JSON of ItemEquipment class for exporting or printing.
|
||||
|
||||
:return: All class attributes stored in a dictionary.
|
||||
"""
|
||||
return asdict(self)
|
||||
111
osrsbox/items_api/item_properties.py
Normal file
111
osrsbox/items_api/item_properties.py
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from dataclasses import asdict
|
||||
from dataclasses import dataclass
|
||||
from typing import Dict
|
||||
from typing import Optional
|
||||
|
||||
from osrsbox.items_api.item_equipment import ItemEquipment
|
||||
from osrsbox.items_api.item_weapon import ItemWeapon
|
||||
|
||||
|
||||
@dataclass
|
||||
class ItemProperties:
|
||||
"""This class defines the object structure and properties for an OSRS item.
|
||||
|
||||
The ItemProperties class is the object that retains all properties and stats
|
||||
for one specific item. Every item has the properties defined in this class.
|
||||
Equipable items have additional properties defined in the linked ItemEquipment
|
||||
class.
|
||||
"""
|
||||
id: int
|
||||
name: str
|
||||
last_updated: str
|
||||
incomplete: bool
|
||||
members: bool
|
||||
tradeable: Optional[bool]
|
||||
tradeable_on_ge: bool
|
||||
stackable: bool
|
||||
stacked: bool
|
||||
noted: bool
|
||||
noteable: bool
|
||||
linked_id_item: Optional[int]
|
||||
linked_id_noted: Optional[int]
|
||||
linked_id_placeholder: Optional[int]
|
||||
placeholder: bool
|
||||
equipable: bool
|
||||
equipable_by_player: bool
|
||||
equipable_weapon: bool
|
||||
cost: int
|
||||
lowalch: int
|
||||
highalch: int
|
||||
weight: Optional[float]
|
||||
buy_limit: Optional[int]
|
||||
quest_item: bool
|
||||
release_date: Optional[str]
|
||||
duplicate: bool
|
||||
examine: Optional[str]
|
||||
icon: str
|
||||
wiki_name: Optional[str]
|
||||
wiki_url: Optional[str]
|
||||
equipment: Optional[ItemEquipment] = None
|
||||
weapon: Optional[ItemWeapon] = None
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_dict: Dict) -> 'ItemProperties':
|
||||
"""Construct ItemProperties object from dictionary/JSON."""
|
||||
# Convert the dictionary under the 'equipment' key into ItemEquipment.
|
||||
if json_dict.get("equipable_by_player"):
|
||||
equipment = json_dict.pop("equipment")
|
||||
json_dict["equipment"] = ItemEquipment(**equipment)
|
||||
|
||||
# Convert the dictionary under the 'weapon' key into ItemWeapon.
|
||||
if json_dict.get("weapon"):
|
||||
weapon = json_dict.pop("weapon")
|
||||
json_dict["weapon"] = ItemWeapon(**weapon)
|
||||
|
||||
return cls(**json_dict)
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary for exporting or printing.
|
||||
|
||||
:return: All class attributes stored in a dictionary.
|
||||
"""
|
||||
return asdict(self)
|
||||
|
||||
def export_json(self, pretty: bool, export_path: str):
|
||||
"""Output ItemProperties to JSON file.
|
||||
|
||||
:param pretty: Toggles pretty (indented) JSON output.
|
||||
:param export_path: The folder location to save the JSON output to.
|
||||
"""
|
||||
json_out = self.construct_json()
|
||||
out_file_name = str(self.id) + ".json"
|
||||
out_file_path = Path(export_path / out_file_name)
|
||||
os.makedirs(os.path.dirname(out_file_path), exist_ok=True)
|
||||
with open(out_file_path, "w") as out_file:
|
||||
if pretty:
|
||||
json.dump(json_out, out_file, indent=4)
|
||||
else:
|
||||
json.dump(json_out, out_file)
|
||||
43
osrsbox/items_api/item_weapon.py
Normal file
43
osrsbox/items_api/item_weapon.py
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from dataclasses import dataclass, asdict
|
||||
from typing import List, Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class ItemWeapon:
|
||||
"""This class defines the properties for an equipable OSRS item that is a weapon.
|
||||
|
||||
The ItemWeapon class is the object that retains all items properties related
|
||||
to equipable items that are weapons. This includes weapon attack speed,
|
||||
weapon type, stance, experience, and bonuses.
|
||||
"""
|
||||
attack_speed: int
|
||||
weapon_type: str
|
||||
stances: List
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary/JSON of ItemWeapon class for exporting or printing.
|
||||
|
||||
:return: All class attributes stored in a dictionary.
|
||||
"""
|
||||
return asdict(self)
|
||||
98
osrsbox/items_api_examples/generate_chunktracker_data.py
Normal file
98
osrsbox/items_api_examples/generate_chunktracker_data.py
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A script to parse the osrsbox item database and export the data to
|
||||
the format needed by the ChuckTracker project:
|
||||
https://github.com/Little0smit/ChunkTracker
|
||||
|
||||
Specified format:
|
||||
{
|
||||
"id": 35,
|
||||
"name": "Excalibur",
|
||||
"equipable": true,
|
||||
"members": true,
|
||||
"stats": {
|
||||
"offensive": [20,29,-2,0,0],
|
||||
"defensive": [0,3,2,1,0],
|
||||
"other": [25,0,0,0,5]
|
||||
},
|
||||
"slot": "weapon",
|
||||
"skill_reqs": {
|
||||
"attack": 20
|
||||
}
|
||||
}
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import json
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load the database
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Setup output dictionary
|
||||
chunk_tracker_data = list()
|
||||
|
||||
# Loop through all items in the database
|
||||
for item in all_db_items:
|
||||
# Convert stats if item is equipable
|
||||
if item.equipable_by_player:
|
||||
offensive = [item.equipment.attack_stab,
|
||||
item.equipment.attack_slash,
|
||||
item.equipment.attack_crush,
|
||||
item.equipment.attack_magic,
|
||||
item.equipment.attack_ranged]
|
||||
defensive = [item.equipment.defence_stab,
|
||||
item.equipment.defence_slash,
|
||||
item.equipment.defence_crush,
|
||||
item.equipment.defence_magic,
|
||||
item.equipment.defence_ranged]
|
||||
other = [item.equipment.melee_strength,
|
||||
item.equipment.ranged_strength,
|
||||
item.equipment.magic_damage,
|
||||
item.equipment.prayer,
|
||||
item.equipment.attack_speed]
|
||||
|
||||
# Append extracted data to a dictionary
|
||||
stats_dict = dict()
|
||||
stats_dict["offensive"] = offensive
|
||||
stats_dict["defensive"] = defensive
|
||||
stats_dict["other"] = other
|
||||
|
||||
# Set properties for the item dictionary
|
||||
item_dict = dict()
|
||||
item_dict["id"] = item.id
|
||||
item_dict["name"] = item.name
|
||||
item_dict["equipable"] = item.equipable
|
||||
item_dict["members"] = item.members
|
||||
item_dict["stats"] = stats_dict
|
||||
item_dict["slot"] = item.equipment.slot
|
||||
item_dict["skill_reqs"] = item.equipment.requirements
|
||||
|
||||
# Add equipable item data to list of all equipable items
|
||||
chunk_tracker_data.append(item_dict)
|
||||
|
||||
# Export extracted data
|
||||
out_file_name = "EquippableItems.json"
|
||||
with open(out_file_name, "w", newline="\n") as out_file:
|
||||
json.dump(chunk_tracker_data, out_file, indent=4)
|
||||
41
osrsbox/items_api_examples/generate_invalid_items.py
Normal file
41
osrsbox/items_api_examples/generate_invalid_items.py
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Helper script for searching/printing invalid items entries.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Loop through all items in the database and print the item name for each item
|
||||
for item in all_db_items:
|
||||
if "Scythe of vitur" in item.name:
|
||||
print(f'''
|
||||
"{item.id}": {{
|
||||
"id": {item.id},
|
||||
"name": "{item.name}",
|
||||
"status": "unequipable",
|
||||
"normalized_name": null
|
||||
}},''')
|
||||
46
osrsbox/items_api_examples/guess_the_item_game.py
Normal file
46
osrsbox/items_api_examples/guess_the_item_game.py
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
"""
|
||||
Author: rosswf
|
||||
Email: ross@rossw.co.uk
|
||||
|
||||
Description:
|
||||
A very simple 'game' that gets a random item's examine text from the osrsbox-db item database
|
||||
and asks the user to guess the name of the item.
|
||||
|
||||
Copyright (c) 2019, rosswf
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
import random
|
||||
|
||||
if __name__ == "__main__":
|
||||
all_db_items = items_api.load()
|
||||
item_found = False
|
||||
item_name = ""
|
||||
while item_found is False:
|
||||
random_id = random.randint(1, len(all_db_items))
|
||||
for item in all_db_items:
|
||||
# Discard items with examine text on None, this is not a required field.
|
||||
if item.examine is not None and item.id == random_id:
|
||||
print(item.examine)
|
||||
item_found = True
|
||||
item_name = item.name
|
||||
|
||||
answer = input("What is this item? ")
|
||||
|
||||
if answer.lower() == item_name.lower():
|
||||
print("Well done!")
|
||||
else:
|
||||
print(f"No, this was {item_name}")
|
||||
41
osrsbox/items_api_examples/items_to_csv.py
Normal file
41
osrsbox/items_api_examples/items_to_csv.py
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and export some of the item metadata to
|
||||
a CSV file.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import csv
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Loop through all items and export to CSV file
|
||||
with open('items.csv', mode="w", newline="") as items_out_fi:
|
||||
items_writer = csv.writer(items_out_fi, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL)
|
||||
items_writer.writerow(["ID", "NAME", "HIGHALCH"])
|
||||
for item in all_db_items:
|
||||
items_writer.writerow([item.id, item.name, item.highalch])
|
||||
66
osrsbox/items_api_examples/lookup_methods_examples.py
Normal file
66
osrsbox/items_api_examples/lookup_methods_examples.py
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and print the item name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Lookup item with ID value of 12 - this will work
|
||||
print(">>> all_db_items.lookup_by_item_id(12)")
|
||||
item = all_db_items.lookup_by_item_id(12)
|
||||
print(item)
|
||||
|
||||
# Lookup item with ID value of 2134314314134 - this will fail
|
||||
# This is why we wrap it in a try/except
|
||||
print(">>> all_db_items.lookup_by_item_id(2134314314134)")
|
||||
try:
|
||||
item = all_db_items.lookup_by_item_id(2134314314134)
|
||||
print(item)
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
# Lookup item with name value of "Coal" - this will work
|
||||
print(">>> all_db_items.lookup_by_item_name(Coal)")
|
||||
item = all_db_items.lookup_by_item_name("Coal")
|
||||
print(item)
|
||||
|
||||
# Lookup item with name value of "Meow" - this will fail
|
||||
print(">>> all_db_items.lookup_by_item_name(Meow)")
|
||||
try:
|
||||
item = all_db_items.lookup_by_item_name("Meow")
|
||||
print(item)
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
# Lookup item with name value of "Overload (Nightmare Zone) (4 doses)" - this will pass
|
||||
print(">>> all_db_items.lookup_by_item_name(Overload (Nightmare Zone) (4 doses))")
|
||||
try:
|
||||
item = all_db_items.lookup_by_item_name("Overload (Nightmare Zone) (4 doses)", use_wiki_name=True)
|
||||
print(item)
|
||||
except ValueError:
|
||||
pass
|
||||
36
osrsbox/items_api_examples/print_all_items.py
Normal file
36
osrsbox/items_api_examples/print_all_items.py
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and print the item name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Loop through all items in the database and print the item name for each item
|
||||
for item in all_db_items:
|
||||
# print(item.id, item.name) # Old, simple printing method
|
||||
print(f"{item.id:<6} {item.name}") # New, f-strings printing method
|
||||
40
osrsbox/items_api_examples/print_f2p_weapons.py
Normal file
40
osrsbox/items_api_examples/print_f2p_weapons.py
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and print and items that are both weapons
|
||||
and available in free to play.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
# Loop through all items in the database and print the item name for each item
|
||||
for item in all_db_items:
|
||||
# Check if item is equipable, and is not memebers (aka f2p item)
|
||||
if item.equipable_by_player and not item.members:
|
||||
# If item is a "weapon" of "2h" weapon, print it!
|
||||
if item.equipment.slot == "weapon" or item.equipment.slot == "2h":
|
||||
print(f"{item.id:<6} {item.name}") # New, f-strings printing method
|
||||
51
osrsbox/items_api_examples/print_highest_prayer_items.py
Normal file
51
osrsbox/items_api_examples/print_highest_prayer_items.py
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and determine items with the highest
|
||||
prayer bonus.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
prayer_items = dict()
|
||||
|
||||
# Populate dict
|
||||
for item in all_db_items:
|
||||
if item.equipable_by_player:
|
||||
prayer_items[item.equipment.slot] = {"prayer_bonus": 0, "name": None}
|
||||
|
||||
# Loop through all items in the database
|
||||
for item in all_db_items:
|
||||
if item.equipable_by_player:
|
||||
item_slot = item.equipment.slot
|
||||
prayer_bonus = item.equipment.prayer
|
||||
|
||||
if prayer_bonus > prayer_items[item_slot]["prayer_bonus"]:
|
||||
prayer_items[item_slot] = {"prayer_bonus": prayer_bonus, "name": item.name}
|
||||
|
||||
for item_slot, info_dict in prayer_items.items():
|
||||
print(f"{item_slot:<10} {info_dict['prayer_bonus']:<10} {info_dict['name']}")
|
||||
48
osrsbox/items_api_examples/print_highest_slash_bonus.py
Normal file
48
osrsbox/items_api_examples/print_highest_slash_bonus.py
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and determine the weapons with the highest
|
||||
slash attack bonus.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from collections import defaultdict
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
top_attack_slash = defaultdict(list)
|
||||
|
||||
# Loop the item database
|
||||
for item in all_db_items:
|
||||
if item.equipable_by_player: # If item is equipable, continue processing
|
||||
# Append equipable item slash bonus, and item name
|
||||
top_attack_slash[item.equipment.attack_slash].append(item.name)
|
||||
|
||||
# Loop sorted dictionary
|
||||
for slash_attack_bonus, items in sorted(top_attack_slash.items(), reverse=True):
|
||||
# Loop item list
|
||||
for item_name in items:
|
||||
print(f"{slash_attack_bonus:<5} {item_name}")
|
||||
54
osrsbox/items_api_examples/print_sort_item_releases.py
Normal file
54
osrsbox/items_api_examples/print_sort_item_releases.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db item database,
|
||||
loop through the loaded items, and print the item name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import collections
|
||||
import datetime
|
||||
|
||||
from osrsbox import items_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all items
|
||||
all_db_items = items_api.load()
|
||||
|
||||
items_by_release_date = collections.defaultdict(list)
|
||||
|
||||
# Loop through all items in the database
|
||||
for item in all_db_items:
|
||||
if item.release_date: # Check item has a release date (aka, not None)
|
||||
# Convert date string to a Python datetime object
|
||||
datetime_object = datetime.datetime.strptime(item.release_date, '%Y-%m-%d')
|
||||
# Append item object to dictionary > list
|
||||
items_by_release_date[datetime_object].append(item)
|
||||
|
||||
# Sort dictionary by release date
|
||||
items_by_release_date = sorted(items_by_release_date.items())
|
||||
|
||||
# Loop dictionary
|
||||
for release_date, items in items_by_release_date:
|
||||
# Loop list of items
|
||||
for item in items:
|
||||
# Print release date (as string), followed by item ID and name
|
||||
print(f"{release_date.strftime('%Y-%m-%d'):<15} {item.id:<10} {item.name}")
|
||||
29
osrsbox/monsters_api/__init__.py
Normal file
29
osrsbox/monsters_api/__init__.py
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from osrsbox.monsters_api import all_monsters
|
||||
|
||||
|
||||
def load() -> all_monsters.AllMonsters:
|
||||
"""Load the osrsbox monster database.
|
||||
|
||||
:return: An AllMonsters object containing the entire monster database.
|
||||
"""
|
||||
return all_monsters.AllMonsters()
|
||||
134
osrsbox/monsters_api/all_monsters.py
Normal file
134
osrsbox/monsters_api/all_monsters.py
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Dict
|
||||
from typing import List
|
||||
from typing import Union
|
||||
from typing import Generator
|
||||
|
||||
from osrsbox.monsters_api.monster_properties import MonsterProperties
|
||||
|
||||
PATH_TO_MONSTERS_COMPLETE = Path(__file__).absolute().parent / ".." / ".." / "docs" / "monsters-complete.json"
|
||||
if not PATH_TO_MONSTERS_COMPLETE.is_file():
|
||||
PATH_TO_MONSTERS_COMPLETE = Path(__file__).absolute().parent / ".." / "docs" / "monsters-complete.json"
|
||||
if not PATH_TO_MONSTERS_COMPLETE.is_file():
|
||||
raise ValueError("Error: Default monsters database file not found. Exiting")
|
||||
|
||||
|
||||
class AllMonsters:
|
||||
"""This class handles loading of the osrsbox-db monsters database.
|
||||
|
||||
:param input_data_file_or_directory: The osrsbox-db monsters folder of JSON files, or single JSON file.
|
||||
"""
|
||||
def __init__(self, input_data_file_or_directory: Path = PATH_TO_MONSTERS_COMPLETE):
|
||||
self.all_monsters: List[MonsterProperties] = list()
|
||||
self.all_monsters_dict: Dict[int, MonsterProperties] = dict()
|
||||
self.load_all_monsters(input_data_file_or_directory)
|
||||
|
||||
def __iter__(self) -> Generator[MonsterProperties, None, None]:
|
||||
"""Iterate (loop) over each MonsterProperties object."""
|
||||
for monster in self.all_monsters:
|
||||
yield monster
|
||||
|
||||
def __getitem__(self, id_number: int) -> MonsterProperties:
|
||||
"""Return the monster definition object for a loaded monster.
|
||||
|
||||
:param id_number: The monster ID number.
|
||||
:return: The monster definition object linked to a specific ID number.
|
||||
"""
|
||||
return self.all_monsters_dict[id_number]
|
||||
|
||||
def __len__(self) -> int:
|
||||
"""Return the count of the total number of monsters.
|
||||
|
||||
:return: The total number of monsters.
|
||||
"""
|
||||
return len(self.all_monsters)
|
||||
|
||||
def load_all_monsters(self, input_data_file_or_directory: Union[Path, str]) -> None:
|
||||
"""Load the monsters database via a JSON file, or directory of JSON files.
|
||||
|
||||
:param input_data_file_or_directory: The path to the data input.
|
||||
:raises ValueError: Valid input not found.
|
||||
"""
|
||||
# Check if a str is supplied, if so, convert to Path object
|
||||
if isinstance(input_data_file_or_directory, str):
|
||||
input_data_file_or_directory = Path(input_data_file_or_directory)
|
||||
|
||||
# Process the directory of JSON, or a single JSON file
|
||||
if input_data_file_or_directory.is_dir():
|
||||
self._load_monsters_from_directory(path_to_directory=input_data_file_or_directory)
|
||||
elif input_data_file_or_directory.is_file():
|
||||
self._load_monsters_from_file(path_to_json_file=input_data_file_or_directory)
|
||||
else:
|
||||
raise ValueError("Error: Valid input not found. Exiting.")
|
||||
|
||||
# Sort the list of monsters
|
||||
self.all_monsters.sort(key=lambda x: x.id)
|
||||
|
||||
def _load_monsters_from_directory(self, path_to_directory: Path) -> None:
|
||||
"""Load monster database from a directory of JSON files (`monsters-json`).
|
||||
|
||||
:param path_to_directory: The path to the `monsters-json` directory.
|
||||
:raises ValueError: No JSON files found in supplied directory.
|
||||
"""
|
||||
# Fetch all .json files in provided dir
|
||||
json_files = list(path_to_directory.glob("*.json"))
|
||||
|
||||
try:
|
||||
json_files[0]
|
||||
except IndexError as e:
|
||||
raise ValueError("Error: No files found in directory, check the supplied path. Exiting.") from e
|
||||
|
||||
# Loop through every monster in JSON file
|
||||
for json_file in json_files:
|
||||
with open(json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
self._load_monster(temp)
|
||||
|
||||
def _load_monsters_from_file(self, path_to_json_file: Path) -> None:
|
||||
"""Load monster database from a single JSON file (`monster-complete.json`).
|
||||
|
||||
:param path_to_json_file: The path to the `monster-complete.json` file.
|
||||
"""
|
||||
with open(path_to_json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
for entry in temp:
|
||||
self._load_monster(temp[entry])
|
||||
|
||||
def _load_monster(self, monster_json: Dict) -> None:
|
||||
"""Convert the `monster_json` into a :class:`MonsterProperties` and store it.
|
||||
|
||||
:param monster_json: A dict from an open and loaded JSON file.
|
||||
:raises ValueError: Cannot populate monster.
|
||||
"""
|
||||
# Load the monster using the MonsterProperties class
|
||||
try:
|
||||
monster_def = MonsterProperties.from_json(monster_json)
|
||||
except TypeError as e:
|
||||
raise ValueError("Error: Invalid JSON structure found, check supplied input. Exiting") from e
|
||||
|
||||
# Add monsters to list
|
||||
self.all_monsters.append(monster_def)
|
||||
self.all_monsters_dict[monster_def.id] = monster_def
|
||||
46
osrsbox/monsters_api/monster_drop.py
Normal file
46
osrsbox/monsters_api/monster_drop.py
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from dataclasses import dataclass, asdict
|
||||
from typing import Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class MonsterDrop:
|
||||
"""This class defines the drops of an OSRS monster.
|
||||
|
||||
The MonsterDrop class is the object that retains all drop properties related
|
||||
to items dropped by a specific monster. This includes item properties (id,
|
||||
name) and drop properties (quantity, rarity, and drop requirements).
|
||||
"""
|
||||
id: int = None
|
||||
name: str = None
|
||||
members: str = None
|
||||
quantity: str = None
|
||||
noted: bool = None
|
||||
rarity: str = None
|
||||
rolls: int = None
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary/JSON of drop entry in a list for exporting or printing.
|
||||
|
||||
:return json_out: A dictionary of a single drop instance.
|
||||
"""
|
||||
return asdict(self)
|
||||
119
osrsbox/monsters_api/monster_properties.py
Normal file
119
osrsbox/monsters_api/monster_properties.py
Normal file
|
|
@ -0,0 +1,119 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import json
|
||||
import os
|
||||
from typing import Dict
|
||||
from typing import List
|
||||
from pathlib import Path
|
||||
from dataclasses import asdict
|
||||
from dataclasses import dataclass
|
||||
|
||||
from osrsbox.monsters_api.monster_drop import MonsterDrop
|
||||
|
||||
|
||||
@dataclass
|
||||
class MonsterProperties:
|
||||
"""This class defines the object structure and properties for an OSRS monster.
|
||||
|
||||
The MonsterProperties class is the object that retains all properties and stats
|
||||
for one specific monster. Every monster has the properties defined in this class,
|
||||
as well as the stats.
|
||||
"""
|
||||
id: int = None
|
||||
name: str = None
|
||||
last_updated: str = None
|
||||
incomplete: bool = None
|
||||
members: bool = None
|
||||
release_date: str = None
|
||||
combat_level: int = None
|
||||
size: int = None
|
||||
hitpoints: int = None
|
||||
max_hit: int = None
|
||||
attack_type: str = None
|
||||
attack_speed: int = None
|
||||
aggressive: bool = None
|
||||
poisonous: bool = None
|
||||
venomous: bool = None
|
||||
immune_poison: bool = None
|
||||
immune_venom: bool = None
|
||||
attributes: List = None
|
||||
category: List = None
|
||||
slayer_monster: bool = None
|
||||
slayer_level: int = None
|
||||
slayer_xp: int = None
|
||||
slayer_masters: List = None
|
||||
duplicate: bool = None
|
||||
examine: str = None
|
||||
wiki_name: str = None
|
||||
wiki_url: str = None
|
||||
attack_level: int = None
|
||||
strength_level: int = None
|
||||
defence_level: int = None
|
||||
magic_level: int = None
|
||||
ranged_level: int = None
|
||||
attack_bonus: int = None
|
||||
strength_bonus: int = None
|
||||
attack_magic: int = None
|
||||
magic_bonus: int = None
|
||||
attack_ranged: int = None
|
||||
ranged_bonus: int = None
|
||||
defence_stab: int = None
|
||||
defence_slash: int = None
|
||||
defence_crush: int = None
|
||||
defence_magic: int = None
|
||||
defence_ranged: int = None
|
||||
drops: List = None
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_dict: Dict) -> List[MonsterDrop]:
|
||||
"""Convert the list under the 'drops' key into actual :class:`MonsterDrop`"""
|
||||
monster_drops = list()
|
||||
if json_dict.get("drops"):
|
||||
for drop in json_dict["drops"]:
|
||||
monster_drops.append(MonsterDrop(**drop))
|
||||
|
||||
json_dict["drops"] = monster_drops
|
||||
|
||||
return cls(**json_dict)
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary/JSON for exporting or printing.
|
||||
|
||||
:return json_out: All class attributes stored in a dictionary.
|
||||
"""
|
||||
return asdict(self)
|
||||
|
||||
def export_json(self, pretty: bool, export_path: str):
|
||||
"""Output Monster to JSON file.
|
||||
|
||||
:param pretty: Toggles pretty (indented) JSON output.
|
||||
:param export_path: The folder location to save the JSON output to.
|
||||
"""
|
||||
json_out = self.construct_json()
|
||||
out_file_name = str(self.id) + ".json"
|
||||
out_file_path = Path(export_path / out_file_name)
|
||||
os.makedirs(os.path.dirname(out_file_path), exist_ok=True)
|
||||
with open(out_file_path, "w", newline="\n") as out_file:
|
||||
if pretty:
|
||||
json.dump(json_out, out_file, indent=4)
|
||||
else:
|
||||
json.dump(json_out, out_file)
|
||||
54
osrsbox/monsters_api_examples/find_rarest_drops.py
Normal file
54
osrsbox/monsters_api_examples/find_rarest_drops.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db monster database,
|
||||
loop through the loaded monsters, and print the monster name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from collections import defaultdict
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all monsters
|
||||
all_db_monsters = monsters_api.load()
|
||||
|
||||
rarest_drop = defaultdict(list)
|
||||
rarest_drop_rate_float = 1.0
|
||||
rarest_drop_rate_fraction = None
|
||||
|
||||
# Loop through all monsters in the database and print the monster name for each monster
|
||||
for monster in all_db_monsters:
|
||||
if monster.drops:
|
||||
for drop in monster.drops:
|
||||
if not drop.rarity:
|
||||
continue
|
||||
drop_rate = eval(drop.rarity)
|
||||
rarest_drop[drop_rate].append(monster)
|
||||
if drop_rate < rarest_drop_rate_float:
|
||||
rarest_drop_rate_float = drop_rate
|
||||
rarest_drop_rate_fraction = drop.rarity
|
||||
|
||||
print("%f" % rarest_drop_rate_float)
|
||||
print(rarest_drop_rate_fraction)
|
||||
for monster in rarest_drop[rarest_drop_rate_float]:
|
||||
print(monster.name)
|
||||
36
osrsbox/monsters_api_examples/print_all_monsters.py
Normal file
36
osrsbox/monsters_api_examples/print_all_monsters.py
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db monster database,
|
||||
loop through the loaded monsters, and print the monster name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all monsters
|
||||
all_db_monsters = monsters_api.load()
|
||||
|
||||
# Loop through all monsters in the database and print the monster name for each monster
|
||||
for monster in all_db_monsters:
|
||||
# print(monster.id, monster.name) # Old, simple printing method
|
||||
print(f"{monster.id:<6} {monster.name}") # New, f-strings printing method
|
||||
53
osrsbox/monsters_api_examples/print_slayer_tasks.py
Normal file
53
osrsbox/monsters_api_examples/print_slayer_tasks.py
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db monster database,
|
||||
loop through the loaded monsters, and print the monster name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
|
||||
slayer_masters_assignments = {
|
||||
"chaeldar": set(),
|
||||
"konar": set(),
|
||||
"turael": set(),
|
||||
"mazchna": set(),
|
||||
"vannaka": set(),
|
||||
"krystilia": set(),
|
||||
"duradel": set(),
|
||||
"nieve": set()
|
||||
}
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all monsters
|
||||
all_db_monsters = monsters_api.load()
|
||||
|
||||
# Loop through all monsters in the database
|
||||
monster_set = set()
|
||||
for monster in all_db_monsters:
|
||||
if monster.slayer_monster:
|
||||
for slayer_master in monster.slayer_masters:
|
||||
slayer_masters_assignments[slayer_master].add(monster.name)
|
||||
|
||||
for slayer_master, assignments in slayer_masters_assignments.items():
|
||||
print(slayer_master)
|
||||
print(assignments)
|
||||
42
osrsbox/monsters_api_examples/search_monster_drops.py
Normal file
42
osrsbox/monsters_api_examples/search_monster_drops.py
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A very simple example script of how to load the osrsbox-db monster database,
|
||||
loop through the loaded monsters, and print the monster name to the console.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all monsters
|
||||
all_db_monsters = monsters_api.load()
|
||||
|
||||
item_search_keyword = "prayer potion"
|
||||
|
||||
# Loop through all monsters in the database and search for items by name
|
||||
print("The following monsters drop prayer potions!!!")
|
||||
print(f"{'ID':<10} {'Name':<25} {'Wiki Name':<25}")
|
||||
for monster in all_db_monsters:
|
||||
if monster.drops:
|
||||
for drop in monster.drops:
|
||||
if item_search_keyword in drop.name.lower():
|
||||
print(f"{monster.id:<10} {monster.name:<25} {monster.wiki_name:<25}")
|
||||
41
osrsbox/monsters_api_examples/test_drops_rarity.py
Normal file
41
osrsbox/monsters_api_examples/test_drops_rarity.py
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A simple script to calculate the rarity of monster drops.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
from osrsbox import monsters_api
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Load all monsters
|
||||
all_db_monsters = monsters_api.load()
|
||||
|
||||
# Loop through all monsters in the database and search for items by name
|
||||
print(f"{'ID':<10} {'Name':<25} {'Rarity Total':<25}")
|
||||
for monster in all_db_monsters:
|
||||
if monster.drops:
|
||||
total_drop_rarity = 0
|
||||
for drop in monster.drops:
|
||||
if drop.rarity == 1.0:
|
||||
continue
|
||||
total_drop_rarity += drop.rarity
|
||||
print(f"{monster.id:<10} {monster.name:<25} {total_drop_rarity:<25}")
|
||||
29
osrsbox/prayers_api/__init__.py
Normal file
29
osrsbox/prayers_api/__init__.py
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from osrsbox.prayers_api import all_prayers
|
||||
|
||||
|
||||
def load() -> all_prayers.AllPrayers:
|
||||
"""Load the prayers database.
|
||||
|
||||
:return all_prayers: An AllPrayers object containing the entire prayer database.
|
||||
"""
|
||||
return all_prayers.AllPrayers()
|
||||
144
osrsbox/prayers_api/all_prayers.py
Normal file
144
osrsbox/prayers_api/all_prayers.py
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Dict, List, Union, Generator
|
||||
|
||||
from osrsbox.prayers_api.prayer_properties import PrayerProperties
|
||||
|
||||
PATH_TO_PRAYERS_COMPLETE_JSON = Path(__file__).absolute().parent / ".." / ".." / "docs" / "prayers-complete.json"
|
||||
if not PATH_TO_PRAYERS_COMPLETE_JSON.is_file():
|
||||
PATH_TO_PRAYERS_COMPLETE_JSON = Path(__file__).absolute().parent / ".." / "docs" / "prayers-complete.json"
|
||||
if not PATH_TO_PRAYERS_COMPLETE_JSON.is_file():
|
||||
raise ValueError("Error: Default prayer database file not found. Exiting")
|
||||
|
||||
|
||||
class AllPrayers:
|
||||
"""This class handles loading of the osrsbox-db prayers database.
|
||||
|
||||
:param input_data_file_or_directory: The osrsbox-db prayers folder of JSON files, or single JSON file.
|
||||
"""
|
||||
def __init__(self, input_data_file_or_directory: Path = PATH_TO_PRAYERS_COMPLETE_JSON):
|
||||
self.all_prayers: List[PrayerProperties] = list()
|
||||
self.all_prayers_dict: Dict[int, PrayerProperties] = dict()
|
||||
self.load_all_prayers(input_data_file_or_directory)
|
||||
|
||||
def __iter__(self) -> Generator[PrayerProperties, None, None]:
|
||||
"""Iterate (loop) over each PrayerProperties object."""
|
||||
for prayer in self.all_prayers:
|
||||
yield prayer
|
||||
|
||||
def __getitem__(self, id_number: int) -> PrayerProperties:
|
||||
"""Return the prayer definition object for a loaded prayer.
|
||||
|
||||
:param id_number: The prayer ID number.
|
||||
:return: The prayer definition object linked to a specific ID number.
|
||||
"""
|
||||
return self.all_prayers_dict[id_number]
|
||||
|
||||
def __len__(self) -> int:
|
||||
"""Return the count of the total number of prayers.
|
||||
|
||||
:return: The total number of prayers.
|
||||
"""
|
||||
return len(self.all_prayers)
|
||||
|
||||
def lookup_by_prayer_id(self, prayer_id_number: int) -> PrayerProperties:
|
||||
"""Lookup a specific prayer ID and get the associated PrayerProperties object.
|
||||
|
||||
:param prayer_id_number: The prayer ID to lookup.
|
||||
:return: The PrayerProperties object found from the lookup.
|
||||
:raises: KeyError when the prayer ID cannot be found.
|
||||
"""
|
||||
try:
|
||||
prayer_properties = self.all_prayers_dict[prayer_id_number]
|
||||
except KeyError:
|
||||
raise KeyError("Cannot find the provided prayer ID number...")
|
||||
return prayer_properties
|
||||
|
||||
def load_all_prayers(self, input_data_file_or_directory: Union[Path, str]) -> None:
|
||||
"""Load the prayers database via a JSON file, or directory of JSON files.
|
||||
|
||||
:param input_data_file_or_directory: The path to the data input.
|
||||
:raises ValueError: Valid input not found.
|
||||
"""
|
||||
# Check if a str is supplied, if so, convert to Path object
|
||||
if isinstance(input_data_file_or_directory, str):
|
||||
input_data_file_or_directory = Path(input_data_file_or_directory)
|
||||
|
||||
# Process the directory of JSON, or a single JSON file
|
||||
if input_data_file_or_directory.is_dir():
|
||||
self._load_prayers_from_directory(path_to_directory=input_data_file_or_directory)
|
||||
elif input_data_file_or_directory.is_file():
|
||||
self._load_prayers_from_file(path_to_json_file=input_data_file_or_directory)
|
||||
else:
|
||||
raise ValueError("Error: Valid input not found. Exiting.")
|
||||
|
||||
# Sort the list of prayers
|
||||
self.all_prayers.sort(key=lambda x: x.id)
|
||||
|
||||
def _load_prayers_from_directory(self, path_to_directory: Path) -> None:
|
||||
"""Load prayer database from a directory of JSON files (`prayers-json`).
|
||||
|
||||
:param path_to_directory: The path to the `prayers-json` directory.
|
||||
:raises ValueError: No JSON files found in supplied directory.
|
||||
"""
|
||||
# Fetch all .json files in provided dir
|
||||
json_files = list(path_to_directory.glob("*.json"))
|
||||
|
||||
try:
|
||||
json_files[0]
|
||||
except IndexError as e:
|
||||
raise ValueError("Error: No files found in directory, check the supplied path. Exiting.") from e
|
||||
|
||||
# Loop through every prayer in JSON file
|
||||
for json_file in json_files:
|
||||
with open(json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
self._load_prayer(temp)
|
||||
|
||||
def _load_prayers_from_file(self, path_to_json_file: Path) -> None:
|
||||
"""Load prayer database from a single JSON file (`prayers-complete.json`).
|
||||
|
||||
:param path_to_json_file: The path to the `prayers-complete.json` file.
|
||||
"""
|
||||
with open(path_to_json_file) as input_json_file:
|
||||
temp = json.load(input_json_file)
|
||||
|
||||
for entry in temp:
|
||||
self._load_prayer(temp[entry])
|
||||
|
||||
def _load_prayer(self, prayer_json: Dict) -> None:
|
||||
"""Convert the `prayer_json` into a :class:`PrayerProperties` and store it.
|
||||
|
||||
:param prayer_json: A dict from an open and loaded JSON file.
|
||||
:raises ValueError: Cannot populate prayer.
|
||||
"""
|
||||
# Load the prayer using the PrayerProperties class
|
||||
try:
|
||||
prayer_def = PrayerProperties.from_json(prayer_json)
|
||||
except TypeError as e:
|
||||
raise ValueError("Error: Invalid JSON structure found, check supplied input. Exiting") from e
|
||||
|
||||
# Add prayer to list
|
||||
self.all_prayers.append(prayer_def)
|
||||
self.all_prayers_dict[prayer_def.id] = prayer_def
|
||||
70
osrsbox/prayers_api/prayer_properties.py
Normal file
70
osrsbox/prayers_api/prayer_properties.py
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from dataclasses import asdict
|
||||
from dataclasses import dataclass
|
||||
from typing import Dict
|
||||
|
||||
|
||||
@dataclass
|
||||
class PrayerProperties:
|
||||
"""This class defines the object structure and properties for an OSRS prayer.
|
||||
|
||||
The PrayerProperties class is the object that retains all properties and stats
|
||||
for one specific prayer.
|
||||
"""
|
||||
id: int = None
|
||||
name: str = None
|
||||
members: bool = None
|
||||
description: str = None
|
||||
drain_per_minute: float = None
|
||||
wiki_url: str = None
|
||||
requirements: Dict = None
|
||||
bonuses: Dict = None
|
||||
icon: str = None
|
||||
|
||||
@classmethod
|
||||
def from_json(cls, json_dict: Dict) -> 'PrayerProperties':
|
||||
"""Construct PrayerProperties object from dictionary/JSON."""
|
||||
return cls(**json_dict)
|
||||
|
||||
def construct_json(self) -> Dict:
|
||||
"""Construct dictionary for exporting or printing.
|
||||
|
||||
:return: All class attributes stored in a dictionary.
|
||||
"""
|
||||
return asdict(self)
|
||||
|
||||
def export_json(self, pretty: bool, export_path: str):
|
||||
"""Output PrayerProperties to JSON file.
|
||||
|
||||
:param pretty: Toggles pretty (indented) JSON output.
|
||||
:param export_path: The folder location to save the JSON output to.
|
||||
"""
|
||||
json_out = self.construct_json()
|
||||
out_file_name = str(self.id) + ".json"
|
||||
out_file_path = Path(export_path / out_file_name)
|
||||
with open(out_file_path, "w") as out_file:
|
||||
if pretty:
|
||||
json.dump(json_out, out_file, indent=4)
|
||||
else:
|
||||
json.dump(json_out, out_file)
|
||||
1180
poetry.lock
generated
Normal file
1180
poetry.lock
generated
Normal file
File diff suppressed because it is too large
Load diff
32
pyproject.toml
Normal file
32
pyproject.toml
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
[tool.poetry]
|
||||
name = "osrsbox"
|
||||
version = "2.2.3"
|
||||
description = "A complete and up-to-date database of Old School Runescape (OSRS) items, monsters and prayers accessible using a Python API."
|
||||
readme="README.md"
|
||||
homepage = "https://github.com/osrsbox/osrsbox-db"
|
||||
repository = "https://github.com/osrsbox/osrsbox-db"
|
||||
authors = ["PH01L <phoil@osrsbox.com>"]
|
||||
license = "GPL-3.0-only"
|
||||
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.6"
|
||||
dataclasses = "python_version < 3.7"
|
||||
aiohttp = "^3.8.1"
|
||||
aiofiles = "^0.8.0"
|
||||
deepdiff = "^5.7.0"
|
||||
requests = "^2.27.1"
|
||||
mwparserfromhell = "^0.6.4"
|
||||
cchardet = "^2.1.7"
|
||||
aiodns = "^3.0.0"
|
||||
tqdm = "^4.63.0"
|
||||
aiohttp-retry = "^2.4.6"
|
||||
Cerberus = "^1.3.4"
|
||||
dateparser = "^1.1.0"
|
||||
|
||||
[tool.poetry.dev-dependencies]
|
||||
setuptools = "^51.0.0"
|
||||
flake8 = "^4.0.1"
|
||||
|
||||
[build-system]
|
||||
requires = ["poetry-core>=1.0.0"]
|
||||
build-backend = "poetry.core.masonry.api"
|
||||
108
rl-plugins/metadatadumper/ItemMetadata.java
Normal file
108
rl-plugins/metadatadumper/ItemMetadata.java
Normal file
|
|
@ -0,0 +1,108 @@
|
|||
/*
|
||||
* Copyright (c) 2019, PH01L <phoil@osrsbox.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package net.runelite.client.plugins.metadatadumper;
|
||||
|
||||
import java.util.Arrays;
|
||||
import lombok.Setter;
|
||||
import net.runelite.api.ItemComposition;
|
||||
|
||||
public class ItemMetadata
|
||||
{
|
||||
@Setter
|
||||
private int id = -1;
|
||||
@Setter
|
||||
private String name = null;
|
||||
@Setter
|
||||
private Boolean members = false;
|
||||
@Setter
|
||||
private Boolean tradeable_on_ge = false;
|
||||
@Setter
|
||||
private Boolean stackable = false;
|
||||
@Setter
|
||||
private Boolean noted = false;
|
||||
@Setter
|
||||
private Boolean noteable = false;
|
||||
@Setter
|
||||
private int linked_id = -1;
|
||||
@Setter
|
||||
private Boolean placeholder = false;
|
||||
@Setter
|
||||
private Boolean equipable = false;
|
||||
@Setter
|
||||
private int cost = -1;
|
||||
@Setter
|
||||
private int low_alch = -1;
|
||||
@Setter
|
||||
private int high_alch = -1;
|
||||
|
||||
public void populateItemMetadata(ItemComposition itemComposition)
|
||||
{
|
||||
// Start by fetching basic properties directly from an ItemDefinition
|
||||
this.id = itemComposition.getId();
|
||||
this.name = itemComposition.getName();
|
||||
this.members = itemComposition.isMembers();
|
||||
this.tradeable_on_ge = itemComposition.isTradeable();
|
||||
this.stackable = itemComposition.isStackable();
|
||||
this.linked_id = itemComposition.getLinkedNoteId();
|
||||
// Determine cost, then alchemy values
|
||||
this.cost = itemComposition.getPrice();
|
||||
this.low_alch = (int)Math.floor(itemComposition.getPrice() * 0.4);
|
||||
this.high_alch = (int)Math.floor(itemComposition.getPrice() * 0.6);
|
||||
|
||||
// Determine if item is noted... According to RuneLite API:
|
||||
// 799 with be returned if the item is noted
|
||||
if (itemComposition.getNote() == 799)
|
||||
{
|
||||
this.noted = true;
|
||||
}
|
||||
|
||||
// Determine if item is notable:
|
||||
if ((itemComposition.getNote() == 799) || (itemComposition.getLinkedNoteId() != -1))
|
||||
{
|
||||
// If the item itself is noted or linked ID is noted, it must be notable!
|
||||
this.noteable = true;
|
||||
}
|
||||
|
||||
// Populate placeholder boolean (is the item ID a placeholder)
|
||||
// 14401 if placeholder, -1 otherwise
|
||||
if (itemComposition.getPlaceholderTemplateId() == 14401)
|
||||
{
|
||||
this.placeholder = true;
|
||||
}
|
||||
|
||||
// Determine if item is equipable:
|
||||
String[] inventoryActions = itemComposition.getInventoryActions();
|
||||
// If inventoryActions contains "Wear", "Wield" or "Equip" it is deemed equipable
|
||||
if (inventoryActions != null)
|
||||
{
|
||||
if (Arrays.asList(inventoryActions).contains("Wear") ||
|
||||
Arrays.asList(inventoryActions).contains("Wield") ||
|
||||
Arrays.asList(inventoryActions).contains("Equip"))
|
||||
{
|
||||
this.equipable = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
57
rl-plugins/metadatadumper/MetadataDumperConfig.java
Normal file
57
rl-plugins/metadatadumper/MetadataDumperConfig.java
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
/*
|
||||
* Copyright (c) 2019, PH01L <phoil@osrsbox.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package net.runelite.client.plugins.metadatadumper;
|
||||
|
||||
import net.runelite.client.config.Config;
|
||||
import net.runelite.client.config.ConfigGroup;
|
||||
import net.runelite.client.config.ConfigItem;
|
||||
|
||||
@ConfigGroup("metadatadumper")
|
||||
public interface MetadataDumperConfig extends Config
|
||||
{
|
||||
@ConfigItem(
|
||||
position = 1,
|
||||
keyName = "dumpItemIcons",
|
||||
name = "Dump icon images",
|
||||
description = "Include dumping of item icon images in PNG format"
|
||||
)
|
||||
default boolean dumpItemIcons() { return false; }
|
||||
|
||||
@ConfigItem(
|
||||
position = 2,
|
||||
keyName = "startConfig",
|
||||
name = "First ID Number",
|
||||
description = "The number to start extraction from"
|
||||
)
|
||||
default int startConfig() { return 0; }
|
||||
|
||||
@ConfigItem(
|
||||
position = 3,
|
||||
keyName = "endConfig",
|
||||
name = "Last ID Number",
|
||||
description = "The number to end extraction at"
|
||||
)
|
||||
default int endConfig() { return 25000; }
|
||||
}
|
||||
210
rl-plugins/metadatadumper/MetadataDumperPlugin.java
Normal file
210
rl-plugins/metadatadumper/MetadataDumperPlugin.java
Normal file
|
|
@ -0,0 +1,210 @@
|
|||
/*
|
||||
* Copyright (c) 2019, PH01L <phoil@osrsbox.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package net.runelite.client.plugins.metadatadumper;
|
||||
|
||||
import com.google.gson.Gson;
|
||||
import com.google.gson.GsonBuilder;
|
||||
import com.google.inject.Provides;
|
||||
import java.io.FileWriter;
|
||||
import java.io.IOException;
|
||||
import java.io.File;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.awt.image.BufferedImage;
|
||||
import javax.imageio.ImageIO;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import javax.inject.Inject;
|
||||
import net.runelite.api.Client;
|
||||
import net.runelite.api.ItemComposition;
|
||||
import net.runelite.api.NPCComposition;
|
||||
import net.runelite.api.events.CommandExecuted;
|
||||
import net.runelite.client.config.ConfigManager;
|
||||
import net.runelite.client.eventbus.Subscribe;
|
||||
import net.runelite.client.plugins.Plugin;
|
||||
import net.runelite.client.plugins.PluginDescriptor;
|
||||
import net.runelite.client.game.ItemManager;
|
||||
|
||||
@Slf4j
|
||||
@PluginDescriptor(
|
||||
name = "Metadata Dumper",
|
||||
description = "Extract metadata for items/npcs from the OSRS Cache",
|
||||
tags = {"osrsbox", "metadata", "scraper", "items", "npcs"},
|
||||
enabledByDefault = false
|
||||
)
|
||||
|
||||
public class MetadataDumperPlugin extends Plugin
|
||||
{
|
||||
private final Map<Integer, ItemMetadata> items = new HashMap<>();
|
||||
private final Map<Integer, NpcMetadata> npcs = new HashMap<>();
|
||||
|
||||
@Inject
|
||||
private Client client;
|
||||
|
||||
@Inject
|
||||
private MetadataDumperConfig config;
|
||||
|
||||
@Inject
|
||||
private ItemManager itemManager;
|
||||
|
||||
@Provides
|
||||
MetadataDumperConfig provideConfig(ConfigManager configManager)
|
||||
{
|
||||
return configManager.getConfig(MetadataDumperConfig.class);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void startUp() throws Exception
|
||||
{
|
||||
log.debug(">>> Starting up MetadataDumperPlugin...");
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void shutDown() throws Exception
|
||||
{
|
||||
log.debug(">>> Shutting down MetadataDumperPlugin...");
|
||||
}
|
||||
|
||||
@Subscribe
|
||||
public void onCommandExecuted(CommandExecuted commandExecuted)
|
||||
{
|
||||
switch (commandExecuted.getCommand())
|
||||
{
|
||||
case "items":
|
||||
{
|
||||
dumpItemMetadata();
|
||||
break;
|
||||
}
|
||||
case "npcs":
|
||||
{
|
||||
dumpNpcMetadata();
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void dumpItemMetadata()
|
||||
{
|
||||
log.debug(">>> Starting item metadata dump...");
|
||||
|
||||
int start = config.startConfig();
|
||||
int end = config.endConfig();
|
||||
|
||||
for(int itemId=start; itemId<end; itemId++)
|
||||
{
|
||||
log.debug(" > Current item ID: " + itemId);
|
||||
|
||||
// Fetch the item composition
|
||||
ItemComposition itemComposition = client.getItemDefinition(itemId);
|
||||
if (itemComposition != null)
|
||||
{
|
||||
if (itemComposition.getName().equalsIgnoreCase("NULL"))
|
||||
{
|
||||
// Skip items with a null name
|
||||
continue;
|
||||
}
|
||||
// Parse the ItemDefinition to an ItemMetadata object
|
||||
ItemMetadata itemMetadata = new ItemMetadata();
|
||||
itemMetadata.populateItemMetadata(itemComposition);
|
||||
items.put(itemId, itemMetadata);
|
||||
}
|
||||
// If user wants to dump item icon image
|
||||
if (config.dumpItemIcons())
|
||||
{
|
||||
// Try to save the item icon
|
||||
try
|
||||
{
|
||||
String directory = "items-icons";
|
||||
File dir = new File(directory);
|
||||
if (!dir.exists()) dir.mkdirs();
|
||||
String outName = "items-icons/" + itemId + ".png";
|
||||
File outputFile = new File(outName);
|
||||
BufferedImage iconImage = itemManager.getImage(itemId);
|
||||
ImageIO.write(iconImage, "png", outputFile);
|
||||
} catch (IOException e)
|
||||
{
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Initialize Gson builder, then generate JSON
|
||||
Gson gson = new GsonBuilder().create();
|
||||
String json = gson.toJson(items);
|
||||
|
||||
// Save items_metadata.json file will all item metadata
|
||||
String summaryFileOut = "items-metadata.json";
|
||||
try (FileWriter fw = new FileWriter(summaryFileOut))
|
||||
{
|
||||
fw.write(json);
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
|
||||
private void dumpNpcMetadata()
|
||||
{
|
||||
log.debug(">>> Starting npc metadata dump...");
|
||||
|
||||
int start = config.startConfig();
|
||||
int end = config.endConfig();
|
||||
|
||||
for(int npcId=start; npcId<end; npcId++)
|
||||
{
|
||||
log.debug(" > Current NPC ID: " + npcId);
|
||||
|
||||
// Fetch the item composition
|
||||
NPCComposition npcComposition = client.getNpcDefinition(npcId);
|
||||
if (npcComposition != null)
|
||||
{
|
||||
if (npcComposition.getName().equalsIgnoreCase("NULL"))
|
||||
{
|
||||
// Skip npcs with a null name
|
||||
continue;
|
||||
}
|
||||
// Parse the NPCComposition to an NpcMetadata object
|
||||
NpcMetadata npcMetadata = new NpcMetadata();
|
||||
npcMetadata.populateNpcMetadata(npcComposition);
|
||||
npcs.put(npcId, npcMetadata);
|
||||
}
|
||||
}
|
||||
|
||||
// Initialize Gson builder, then generate JSON
|
||||
Gson gson = new GsonBuilder().create();
|
||||
String json = gson.toJson(npcs);
|
||||
|
||||
// Save items_metadata.json file will all item metadata
|
||||
String summaryFileOut = "npcs-metadata.json";
|
||||
try (FileWriter fw = new FileWriter(summaryFileOut))
|
||||
{
|
||||
fw.write(json);
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
e.printStackTrace();
|
||||
}
|
||||
}
|
||||
}
|
||||
58
rl-plugins/metadatadumper/NpcMetadata.java
Normal file
58
rl-plugins/metadatadumper/NpcMetadata.java
Normal file
|
|
@ -0,0 +1,58 @@
|
|||
/*
|
||||
* Copyright (c) 2019, PH01L <phoil@osrsbox.com>
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright notice, this
|
||||
* list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||||
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package net.runelite.client.plugins.metadatadumper;
|
||||
|
||||
import lombok.Setter;
|
||||
import net.runelite.api.NPCComposition;
|
||||
|
||||
public class NpcMetadata
|
||||
{
|
||||
@Setter
|
||||
private int id = -1;
|
||||
@Setter
|
||||
private String name = null;
|
||||
@Setter
|
||||
private int combat_level = -1;
|
||||
@Setter
|
||||
private int[] model_ids = null;
|
||||
@Setter
|
||||
private int size = -1;
|
||||
@Setter
|
||||
private Boolean clickable = false;
|
||||
@Setter
|
||||
private String[] actions = null;
|
||||
|
||||
public void populateNpcMetadata(NPCComposition npcComposition)
|
||||
{
|
||||
// Start by fetching basic properties directly from an NPCComposition
|
||||
this.id = npcComposition.getId();
|
||||
this.name = npcComposition.getName();
|
||||
this.combat_level = npcComposition.getCombatLevel();
|
||||
this.model_ids = npcComposition.getModels();
|
||||
this.size = npcComposition.getSize();
|
||||
this.clickable = npcComposition.isClickable();
|
||||
this.actions = npcComposition.getActions();
|
||||
}
|
||||
}
|
||||
1
runelite
Submodule
1
runelite
Submodule
|
|
@ -0,0 +1 @@
|
|||
Subproject commit eabaa9cab42cc368ad80107233f771f6c754a8ef
|
||||
67
scripts/cache/cache_constants.py
vendored
Normal file
67
scripts/cache/cache_constants.py
vendored
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Constant variables used in the OSRS cache tools in this repository.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
|
||||
CACHE_DUMP_TYPES = [
|
||||
"items",
|
||||
"npcs",
|
||||
"objects"
|
||||
]
|
||||
|
||||
ITEM_DEFINITIONS = dict()
|
||||
NPC_DEFINITIONS = dict()
|
||||
OBJECT_DEFINITIONS = dict()
|
||||
|
||||
all_cache_items = sorted(Path(config.DATA_CACHE_PATH / "items").glob("*.json"),
|
||||
key=lambda path: int(path.stem))
|
||||
if len(all_cache_items) == 0:
|
||||
print(">>> ERROR: scripts.cache.cache_constants")
|
||||
exit(">>> Could not load item cache files. Exiting.")
|
||||
for cache_file in all_cache_items:
|
||||
with open(cache_file) as f:
|
||||
data = json.load(f)
|
||||
ITEM_DEFINITIONS[str(data["id"])] = data
|
||||
|
||||
all_cache_npcs = sorted(Path(config.DATA_CACHE_PATH / "npcs").glob("*.json"),
|
||||
key=lambda path: int(path.stem))
|
||||
if len(all_cache_npcs) == 0:
|
||||
print(">>> ERROR: scripts.cache.cache_constants")
|
||||
exit(">>> Could not load npc cache files. Exiting.")
|
||||
for cache_file in all_cache_npcs:
|
||||
with open(cache_file) as f:
|
||||
data = json.load(f)
|
||||
NPC_DEFINITIONS[str(data["id"])] = data
|
||||
|
||||
all_cache_objects = sorted(Path(config.DATA_CACHE_PATH / "objects").glob("*.json"),
|
||||
key=lambda path: int(path.stem))
|
||||
if len(all_cache_objects) == 0:
|
||||
print(">>> ERROR: scripts.cache.cache_constants")
|
||||
exit(">>> Could not load object cache files. Exiting.")
|
||||
for cache_file in all_cache_objects:
|
||||
with open(cache_file) as f:
|
||||
data = json.load(f)
|
||||
OBJECT_DEFINITIONS[str(data["id"])] = data
|
||||
222
scripts/cache/determine_changes.py
vendored
Normal file
222
scripts/cache/determine_changes.py
vendored
Normal file
|
|
@ -0,0 +1,222 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A script to determine new items and monsters added after a game
|
||||
update. This is used to help update the CHANGELOG in the repository.
|
||||
This script takes two different files inputs for items and monsters:
|
||||
- items: data/items-cache-data.json
|
||||
- monsters: data/monsters-cache-data.json
|
||||
When generated, both files should exist in: data/cache/ and the files
|
||||
should be copied to: data/
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
from pprint import pprint
|
||||
from typing import List
|
||||
from typing import Dict
|
||||
|
||||
import config
|
||||
|
||||
|
||||
class DetermineCacheChanges:
|
||||
"""A class to determine added, removed, changed and unchanged entries.
|
||||
|
||||
Every OSRS weekly update has the potential to add, remove or change item
|
||||
and monster properties. This class analyzes the OSRS cache dump of the
|
||||
existing entries and compares to a new database dump.
|
||||
|
||||
:param current_dict: A dictionary of the new items_scraper.json file
|
||||
:param past_dict: A dictionary of the old items_scraper.json file
|
||||
"""
|
||||
def __init__(self, current_dict: Dict, past_dict: Dict):
|
||||
self.current_dict = current_dict
|
||||
self.past_dict = past_dict
|
||||
self.set_current = set(current_dict.keys())
|
||||
self.set_past = set(past_dict.keys())
|
||||
self.intersect = self.set_current.intersection(self.set_past)
|
||||
|
||||
def added(self) -> List:
|
||||
"""Return a set of only new IDs that is sorted."""
|
||||
added = self.set_current - self.intersect
|
||||
added = sorted(added)
|
||||
return added
|
||||
|
||||
def removed(self) -> List:
|
||||
"""Return a set of only removed IDs that is sorted."""
|
||||
removed = self.set_past - self.intersect
|
||||
removed = sorted(removed)
|
||||
return removed
|
||||
|
||||
def changed(self) -> List:
|
||||
"""Return a set of only changed entries (including properties) that is sorted."""
|
||||
changed = set(o for o in self.intersect if self.past_dict[o] != self.current_dict[o])
|
||||
changed = sorted(changed)
|
||||
return changed
|
||||
|
||||
def unchanged(self) -> List:
|
||||
"""Return a set of only unchanged entries (including properties) that is sorted."""
|
||||
unchanged = set(o for o in self.intersect if self.past_dict[o] == self.current_dict[o])
|
||||
unchanged = sorted(unchanged)
|
||||
return unchanged
|
||||
|
||||
|
||||
def items():
|
||||
"""The main function for determining item changes."""
|
||||
# Read in the old items-cache-data.json file
|
||||
fi_name = Path(config.DATA_ITEMS_PATH / "items-cache-data.json")
|
||||
os.makedirs(os.path.dirname(fi_name), exist_ok=True)
|
||||
fi_name.touch(exist_ok=True)
|
||||
with open(fi_name, mode='r+') as f:
|
||||
try:
|
||||
old_items = json.load(f)
|
||||
except json.decoder.JSONDecodeError:
|
||||
old_items = dict()
|
||||
pprint(f"No old item cache data")
|
||||
|
||||
# Read in the new items-cache-data.json file
|
||||
fi_name = Path(config.DATA_ITEMS_PATH / "items-cache-data-new.json")
|
||||
os.makedirs(os.path.dirname(fi_name), exist_ok=True)
|
||||
with open(fi_name, mode='r+') as f:
|
||||
new_items = json.load(f)
|
||||
|
||||
# Initialize class
|
||||
dd = DetermineCacheChanges(new_items, old_items)
|
||||
|
||||
# Determine added items
|
||||
added = dd.added()
|
||||
print("- Added items: %d" % len(added))
|
||||
for itemID in added:
|
||||
print(" - %s,%s" % (itemID,
|
||||
new_items[itemID]["name"]))
|
||||
|
||||
# Determine removed items
|
||||
removed = dd.removed()
|
||||
print("- Removed items: %d" % len(removed))
|
||||
for itemID in removed:
|
||||
print(" - %s,%s" % (itemID,
|
||||
old_items[itemID]["name"]))
|
||||
|
||||
# Determine changed items
|
||||
changed = dd.changed()
|
||||
print("- Changed items: %d" % len(changed))
|
||||
for itemID in changed:
|
||||
changed_keys = list()
|
||||
for key in new_items[itemID]:
|
||||
if new_items[itemID][key] != old_items[itemID][key]:
|
||||
changed_keys.append(key)
|
||||
if changed_keys:
|
||||
print(" - %s,%s,%s" % (itemID,
|
||||
old_items[itemID]["name"],
|
||||
'|'.join(changed_keys)))
|
||||
|
||||
# # Determine unchanged items
|
||||
# # This is commented out, as the results are always large
|
||||
# unchanged = dd.unchanged()
|
||||
# print("- Unchanged items: %d" % len(unchanged))
|
||||
# for itemID in unchanged:
|
||||
# print(" - %s,%s" % (itemID,
|
||||
# new_items[itemID]["name"]))
|
||||
|
||||
|
||||
def monsters():
|
||||
"""The main function for determining monster changes."""
|
||||
# Read in the old monsters-cache-data.json file
|
||||
fi_name = Path(config.DATA_MONSTERS_PATH / "monsters-cache-data.json")
|
||||
os.makedirs(os.path.dirname(fi_name), exist_ok=True)
|
||||
fi_name.touch(exist_ok=True)
|
||||
with open(fi_name) as f:
|
||||
try:
|
||||
old_monsters = json.load(f)
|
||||
except json.decoder.JSONDecodeError:
|
||||
old_monsters = dict()
|
||||
pprint(f"No old monster cache data")
|
||||
|
||||
# Read in the new monsters-cache-data.json file
|
||||
fi_name = Path(config.DATA_MONSTERS_PATH / "monsters-cache-data-new.json")
|
||||
with open(fi_name) as f:
|
||||
new_monsters = json.load(f)
|
||||
|
||||
# Initialize class
|
||||
dd = DetermineCacheChanges(new_monsters, old_monsters)
|
||||
|
||||
# Determine added monsters
|
||||
added = dd.added()
|
||||
print("- Added monsters: %d" % len(added))
|
||||
for monsterID in added:
|
||||
print(" - %s,%s" % (monsterID,
|
||||
new_monsters[monsterID]["name"]))
|
||||
|
||||
# Determine removed monsters
|
||||
removed = dd.removed()
|
||||
print("- Removed monsters: %d" % len(removed))
|
||||
for monsterID in removed:
|
||||
print(" - %s,%s" % (monsterID,
|
||||
old_monsters[monsterID]["name"]))
|
||||
|
||||
# Determine changed monsters
|
||||
changed = dd.changed()
|
||||
print("- Changed monsters: %d" % len(changed))
|
||||
for monsterID in changed:
|
||||
changed_keys = list()
|
||||
for key in new_monsters[monsterID]:
|
||||
new_monsters_key = new_monsters[monsterID].get(key)
|
||||
old_monsters_key = old_monsters[monsterID].get(key)
|
||||
if new_monsters_key is None or old_monsters_key is None:
|
||||
continue
|
||||
if new_monsters[monsterID][key] != old_monsters[monsterID][key]:
|
||||
changed_keys.append(key)
|
||||
if changed_keys:
|
||||
print(" - %s,%s,%s" % (monsterID,
|
||||
old_monsters[monsterID]["name"],
|
||||
'|'.join(changed_keys)))
|
||||
|
||||
# # Determine unchanged monsters
|
||||
# # This is commented out, as the results are always large
|
||||
# unchanged = dd.unchanged()
|
||||
# print("- Unchanged monsters: %d" % len(unchanged))
|
||||
# for monsterID in unchanged:
|
||||
# print(" - %s,%s" % (monsterID,
|
||||
# new_monsters[monsterID]["name"]))
|
||||
|
||||
|
||||
def move():
|
||||
"""Move cache files."""
|
||||
old = Path(config.DATA_ITEMS_PATH / "items-cache-data.json")
|
||||
new = Path(config.DATA_ITEMS_PATH / "items-cache-data-new.json")
|
||||
old.unlink()
|
||||
new.rename(old)
|
||||
|
||||
old = Path(config.DATA_MONSTERS_PATH / "monsters-cache-data.json")
|
||||
new = Path(config.DATA_MONSTERS_PATH / "monsters-cache-data-new.json")
|
||||
old.unlink()
|
||||
new.rename(old)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
print("Determining item changes using items-cache-data.json files...")
|
||||
items()
|
||||
|
||||
print("Determining monster changes using monsters-cache-data.json files...")
|
||||
monsters()
|
||||
|
||||
print("Overwrite old files")
|
||||
move()
|
||||
211
scripts/cache/generate_items_cache_data.py
vendored
Normal file
211
scripts/cache/generate_items_cache_data.py
vendored
Normal file
|
|
@ -0,0 +1,211 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Generate the items-cache-data.json file from raw Item Definition files.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Dict
|
||||
|
||||
import config
|
||||
from scripts.cache import cache_constants
|
||||
|
||||
|
||||
def parse_item_definition(item_data: Dict, definitions: Dict, id_number: str) -> Dict:
|
||||
"""Parse the raw cache ItemDefinition data to a Python dictionary.
|
||||
|
||||
:param item_data: A dictionary holding item properties.
|
||||
:param definitions: A dictionary holding the raw ItemDefinition data.
|
||||
:param id_number: The item ID number to process
|
||||
"""
|
||||
item_definition = definitions[id_number]
|
||||
item_data["name"] = item_definition["name"]
|
||||
item_data["tradeable_on_ge"] = item_definition["isTradeable"]
|
||||
item_data["members"] = item_definition["members"]
|
||||
|
||||
# Determine any linked IDs (item, placeholder, noted)
|
||||
item_data["linked_id_item"] = None
|
||||
|
||||
if item_definition["notedID"] != -1 and item_definition["notedTemplate"] != 799:
|
||||
item_data["linked_id_noted"] = item_definition["notedID"]
|
||||
else:
|
||||
item_data["linked_id_noted"] = None
|
||||
|
||||
if item_definition["placeholderId"] != -1 and item_definition["placeholderTemplateId"] != 14401:
|
||||
item_data["linked_id_placeholder"] = item_definition["placeholderId"]
|
||||
else:
|
||||
item_data["linked_id_placeholder"] = None
|
||||
|
||||
# Determine if the item is noted
|
||||
if item_definition["notedTemplate"] == 799:
|
||||
item_data["noted"] = True
|
||||
else:
|
||||
item_data["noted"] = False
|
||||
|
||||
# Determine if the item is noteable
|
||||
if item_definition["notedTemplate"] == 799:
|
||||
# Item is noted, so it must be notable
|
||||
item_data["noteable"] = True
|
||||
elif item_data["linked_id_noted"] is not None:
|
||||
if definitions[str(item_data["linked_id_noted"])]["notedTemplate"] == 799:
|
||||
# If linked item ID is noted, this item must also be noteable
|
||||
item_data["noteable"] = True
|
||||
else:
|
||||
item_data["noteable"] = False
|
||||
|
||||
# Determine if the item is a placeholder
|
||||
if item_definition["placeholderTemplateId"] == 14401:
|
||||
item_data["placeholder"] = True
|
||||
else:
|
||||
item_data["placeholder"] = False
|
||||
|
||||
# Determine item stackability
|
||||
if item_definition["stackable"] == 1:
|
||||
item_data["stackable"] = True
|
||||
else:
|
||||
item_data["stackable"] = False
|
||||
|
||||
# Determine item equipability
|
||||
if "Wear" in item_definition["interfaceOptions"]:
|
||||
item_data["equipable"] = True
|
||||
elif "Wield" in item_definition["interfaceOptions"]:
|
||||
item_data["equipable"] = True
|
||||
elif "Equip" in item_definition["interfaceOptions"]:
|
||||
item_data["equipable"] = True
|
||||
else:
|
||||
item_data["equipable"] = False
|
||||
|
||||
# Get cost of item, then determine lowalch and highalch
|
||||
item_data["cost"] = item_definition["cost"]
|
||||
item_data["lowalch"] = int(item_data["cost"] * 0.4)
|
||||
item_data["highalch"] = int(item_data["cost"] * 0.6)
|
||||
|
||||
return item_data
|
||||
|
||||
|
||||
def parse_item_definition_fix_linked_item(item_data: Dict, definitions: Dict, id_number: str) -> Dict:
|
||||
"""Parse the raw cache ItemDefinition data to a Python dictionary.
|
||||
|
||||
This function tries to fix any item that is linked, by looking up properties
|
||||
from the linked item ID and re-populating the name, members, cost, lowalch
|
||||
and highalch properties.
|
||||
|
||||
:param item_data: A dictionary holding item properties.
|
||||
:param definitions: A dictionary holding the raw ItemDefinition data.
|
||||
:param id_number: The item ID number to process.
|
||||
"""
|
||||
item_definition = definitions[id_number]
|
||||
item_data["name"] = item_definition["name"]
|
||||
item_data["members"] = item_definition["members"]
|
||||
item_data["cost"] = item_definition["cost"]
|
||||
item_data["lowalch"] = int(item_data["cost"] * 0.4)
|
||||
item_data["highalch"] = int(item_data["cost"] * 0.6)
|
||||
return item_data
|
||||
|
||||
|
||||
def process():
|
||||
"""Extract item definition data, and process for builder ingestion."""
|
||||
all_items = dict()
|
||||
definitions = cache_constants.ITEM_DEFINITIONS
|
||||
|
||||
with open(Path(config.DATA_ITEMS_PATH / "items-stacked.json")) as f:
|
||||
stacked_variants = json.load(f)
|
||||
|
||||
# Loop the loaded data
|
||||
for id_number in definitions:
|
||||
# Initialize the dictionary to store each item properties
|
||||
item_data = dict()
|
||||
|
||||
# Fetch the specific item definition being processed
|
||||
item_definition = definitions[id_number]
|
||||
|
||||
# Get the item ID
|
||||
item_data["id"] = item_definition["id"]
|
||||
itemid = str(item_definition["id"])
|
||||
|
||||
# Parse the item
|
||||
item_data = parse_item_definition(item_data, definitions, id_number)
|
||||
|
||||
if itemid in stacked_variants:
|
||||
# This item is a stacked variant (found in countObj)
|
||||
linked_id_number = str(stacked_variants[itemid]["id"])
|
||||
# Parse linked item id to get missing properties
|
||||
item_data = parse_item_definition_fix_linked_item(item_data,
|
||||
definitions,
|
||||
linked_id_number)
|
||||
item_data["linked_id_item"] = int(linked_id_number)
|
||||
# Set tradeable_og_ge to False, as stacked variants not tradeable on GE
|
||||
item_data["tradeable_on_ge"] = False
|
||||
# Manually set "stacked" property to True
|
||||
item_data["stacked"] = stacked_variants[itemid]["count"]
|
||||
|
||||
elif (item_definition["name"] == "null" and
|
||||
item_definition["notedTemplate"] == 799):
|
||||
# This item is noted (notedTemplate is 799)
|
||||
# The linked ID must be queried for name, members, cost, lowalch, highalch
|
||||
linked_id_number = str(item_definition["notedID"])
|
||||
item_data = parse_item_definition_fix_linked_item(item_data,
|
||||
definitions,
|
||||
linked_id_number)
|
||||
item_data["linked_id_item"] = int(linked_id_number)
|
||||
|
||||
elif (item_definition["name"] == "null" and
|
||||
item_definition["placeholderTemplateId"] == 14401):
|
||||
# This item is a placeholder (placeholderTemplateId is 14401)
|
||||
linked_id_number = str(item_definition["placeholderId"])
|
||||
# This item needs a name set
|
||||
item_data["name"] = definitions[linked_id_number]["name"]
|
||||
item_data["linked_id_item"] = int(linked_id_number)
|
||||
|
||||
elif (item_definition["name"] == "null" and
|
||||
item_definition["boughtTemplateId"] == 13189):
|
||||
# This item is bought (boughtTemplateId is 13189)
|
||||
linked_id_number = str(item_definition["boughtId"])
|
||||
# This item needs a name set
|
||||
item_data["name"] = definitions[linked_id_number]["name"]
|
||||
item_data["linked_id_item"] = int(linked_id_number)
|
||||
|
||||
elif item_definition["name"] == "null":
|
||||
# Skip this item, it is not useful
|
||||
continue
|
||||
|
||||
# Check extracted item name, if name is null or empty, skip it
|
||||
item_name = item_data["name"].lower()
|
||||
if item_name == "null" or item_name == "":
|
||||
# Skip this item, it is not useful
|
||||
continue
|
||||
|
||||
# Check if stacked property is set
|
||||
try:
|
||||
int(item_data["stacked"])
|
||||
except KeyError:
|
||||
item_data["stacked"] = None
|
||||
|
||||
all_items[str(item_data["id"])] = item_data
|
||||
|
||||
# Finally, dump the extracted data to the items-cache-data.json file
|
||||
out_fi = Path(config.DATA_ITEMS_PATH / "items-cache-data-new.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(all_items, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
process()
|
||||
74
scripts/cache/generate_items_stacked_variants.py
vendored
Normal file
74
scripts/cache/generate_items_stacked_variants.py
vendored
Normal file
|
|
@ -0,0 +1,74 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Generate the item stacked variants.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from scripts.cache import cache_constants
|
||||
|
||||
|
||||
def process():
|
||||
"""Extract find all stacked item variants in ItemDefinition data."""
|
||||
definitions = cache_constants.ITEM_DEFINITIONS
|
||||
stacked_variants = dict()
|
||||
|
||||
# Loop the loaded data
|
||||
for id_number in definitions:
|
||||
# Fetch the specific item definition being processed
|
||||
item_definition = definitions[id_number]
|
||||
|
||||
# Determine if item has stacked variants
|
||||
try:
|
||||
is_stacked = item_definition["countObj"]
|
||||
except KeyError:
|
||||
is_stacked = False
|
||||
|
||||
# Process stacked items
|
||||
if is_stacked:
|
||||
for stacked_id, stacked_count in zip(item_definition["countObj"], item_definition["countCo"]):
|
||||
# Skip any entry that is a zero (empty)
|
||||
if stacked_id == 0:
|
||||
pass
|
||||
else:
|
||||
# Skip any ID that has already been processed
|
||||
if stacked_id in stacked_variants:
|
||||
pass
|
||||
else:
|
||||
stacked_dict = dict()
|
||||
stacked_dict["id"] = item_definition["id"]
|
||||
stacked_dict["count"] = stacked_count
|
||||
stacked_variants[stacked_id] = stacked_dict
|
||||
|
||||
# Finally, dump the extracted stacked item IDs to the items-cache-data.json file
|
||||
out_fi = Path(config.DATA_ITEMS_PATH / "items-stacked.json")
|
||||
os.makedirs(os.path.dirname(out_fi), exist_ok=True)
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(stacked_variants, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
# Determine items with stacked variants. Example:
|
||||
# 23663: 23661
|
||||
process()
|
||||
64
scripts/cache/generate_monsters_cache_data.py
vendored
Normal file
64
scripts/cache/generate_monsters_cache_data.py
vendored
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Generate the monsters-cache-data.json file from raw NPC Definition files.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from scripts.cache import cache_constants
|
||||
|
||||
|
||||
def process():
|
||||
"""Main function to extract attackble NPC definition files."""
|
||||
definitions = cache_constants.NPC_DEFINITIONS
|
||||
attackable_npcs = dict()
|
||||
|
||||
# Loop all entries in the loaded definition files
|
||||
for id_number in definitions:
|
||||
json_data = definitions[id_number]
|
||||
|
||||
# Before checking if attackable, add a couple of
|
||||
# known monsters that are "death" versions...
|
||||
if json_data["id"] in [8622, 9432, 9433]:
|
||||
attackable_npcs[id_number] = json_data
|
||||
|
||||
if "Attack" in json_data["actions"]:
|
||||
# Skip entries with variable menu list color in name
|
||||
if "<col" in json_data["name"]:
|
||||
continue
|
||||
if json_data["name"] in ["Null", "null", ""]:
|
||||
continue
|
||||
|
||||
# Save the attackable NPC
|
||||
attackable_npcs[id_number] = json_data
|
||||
|
||||
# Save all extracted attackable NPCs to JSON file
|
||||
out_fi = Path(config.DATA_MONSTERS_PATH / "monsters-cache-data-new.json")
|
||||
os.makedirs(os.path.dirname(out_fi), exist_ok=True)
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(attackable_npcs, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
process()
|
||||
73
scripts/cache/generate_summary_files.py
vendored
Normal file
73
scripts/cache/generate_summary_files.py
vendored
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Generate summary of item, npc and object cache definition files.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from scripts.cache import cache_constants
|
||||
|
||||
|
||||
def process():
|
||||
"""Main function to extract item/npc/object summary (ID and name)."""
|
||||
for cache_name in cache_constants.CACHE_DUMP_TYPES:
|
||||
summary_data = dict()
|
||||
|
||||
if cache_name == "items":
|
||||
definitions = cache_constants.ITEM_DEFINITIONS
|
||||
elif cache_name == "npcs":
|
||||
definitions = cache_constants.NPC_DEFINITIONS
|
||||
elif cache_name == "objects":
|
||||
definitions = cache_constants.OBJECT_DEFINITIONS
|
||||
|
||||
# Loop all entries in the decompressed and loaded definition file
|
||||
for id_number in definitions:
|
||||
json_data = definitions[id_number]
|
||||
id = json_data["id"]
|
||||
name = json_data["name"]
|
||||
# Check if there is a non-valid name
|
||||
if "<col" in json_data["name"]:
|
||||
continue
|
||||
if "null" in json_data["name"].lower():
|
||||
continue
|
||||
summary_data[id] = {
|
||||
"id": id,
|
||||
"name": name
|
||||
}
|
||||
|
||||
# Save all extracted entries to a JSON file
|
||||
if cache_name == "items":
|
||||
out_fi = Path(config.DOCS_PATH / "items-summary.json")
|
||||
elif cache_name == "npcs":
|
||||
out_fi = Path(config.DOCS_PATH / "npcs-summary.json")
|
||||
elif cache_name == "objects":
|
||||
out_fi = Path(config.DOCS_PATH / "objects-summary.json")
|
||||
|
||||
os.makedirs(os.path.dirname(out_fi), exist_ok=True)
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(summary_data, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
process()
|
||||
160
scripts/cache/generate_summary_models.py
vendored
Normal file
160
scripts/cache/generate_summary_models.py
vendored
Normal file
|
|
@ -0,0 +1,160 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Parse OSRS cache data and extract model ID numbers for items, npcs, and
|
||||
objects. Known keys for models:
|
||||
- items: inventoryModel
|
||||
- npcs: models, models_2 (version 2 does not seem to be used)
|
||||
- objects: objectModels
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import List
|
||||
from typing import Dict
|
||||
|
||||
import config
|
||||
from scripts.cache import cache_constants
|
||||
|
||||
SKIP_EMPTY_NAMES = ("null", "Null", "")
|
||||
|
||||
|
||||
def extract_model_ids_int(json_data: Dict) -> List[Dict]:
|
||||
"""Extracts the model ID numbers for NPCs and NPC Chat heads.
|
||||
|
||||
:param json_data: A dictionary from an item, npc or object definition file.
|
||||
:return models: A list of dictionaries containing ID, type, type ID and model ID.
|
||||
"""
|
||||
# Set up output dict (to be populated with 1 or more model_dict)
|
||||
models = {}
|
||||
|
||||
model_keys = {
|
||||
"item_model_ground": "inventoryModel",
|
||||
"item_model_male0": "maleModel0",
|
||||
"item_model_male1": "maleModel1",
|
||||
"item_model_male2": "maleModel2",
|
||||
"item_model_female0": "femaleModel0",
|
||||
"item_model_female1": "femaleModel1",
|
||||
"item_model_female2": "femaleModel2"
|
||||
}
|
||||
|
||||
for model_type, model_key in model_keys.items():
|
||||
model_dict = dict()
|
||||
# Set base properties
|
||||
model_dict["model_type"] = model_type
|
||||
model_dict["model_type_id"] = json_data["id"]
|
||||
model_dict["model_name"] = json_data["name"]
|
||||
|
||||
# Extract NPC model numbers
|
||||
try:
|
||||
model_dict["model_ids"] = json_data[model_key]
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
if model_dict["model_ids"] == -1:
|
||||
continue
|
||||
|
||||
model_dict_key = f"{model_dict['model_type']}_{model_dict['model_type_id']}_{model_dict['model_ids']}"
|
||||
|
||||
models[model_dict_key] = model_dict
|
||||
|
||||
# Return a list of model_dicts
|
||||
return models
|
||||
|
||||
|
||||
def extract_model_ids_list(json_data: Dict) -> List[Dict]:
|
||||
"""Extracts the model ID numbers for ground, male and female item models.
|
||||
|
||||
:param json_data: A dictionary from an item, npc or object definition file.
|
||||
:return models: A list of dictionaries containing ID, type, type ID and model ID.
|
||||
"""
|
||||
# Set up output dict (to be populated with 1 or more model_dict)
|
||||
models = {}
|
||||
|
||||
model_keys = {
|
||||
"npc_model": "models",
|
||||
"npc_chathead": "chatheadModels",
|
||||
"object_model": "objectModels"
|
||||
}
|
||||
|
||||
for model_type, model_key in model_keys.items():
|
||||
model_dict = dict()
|
||||
# Set base properties
|
||||
model_dict["model_type"] = model_type
|
||||
model_dict["model_type_id"] = json_data["id"]
|
||||
model_dict["model_name"] = json_data["name"]
|
||||
|
||||
# Extract NPC model numbers
|
||||
try:
|
||||
model_dict["model_ids"] = ", ".join(str(n) for n in json_data[model_key])
|
||||
except KeyError:
|
||||
continue
|
||||
|
||||
model_dict_key = f"{model_dict['model_type']}_{model_dict['model_type_id']}_{model_dict['model_ids']}"
|
||||
|
||||
models[model_dict_key] = model_dict
|
||||
|
||||
# Return a list of model_dicts
|
||||
return models
|
||||
|
||||
|
||||
def process():
|
||||
"""Extract OSRS model ID numbers that map to names."""
|
||||
all_models = dict()
|
||||
|
||||
# Loop three cache types (items, npcs and objects)
|
||||
all_definitions = {
|
||||
"items": cache_constants.ITEM_DEFINITIONS,
|
||||
"npcs": cache_constants.NPC_DEFINITIONS,
|
||||
"objects": cache_constants.OBJECT_DEFINITIONS
|
||||
}
|
||||
|
||||
for cache_name, definitions in all_definitions.items():
|
||||
# Loop all entries in the loaded definition file
|
||||
for id_number in definitions:
|
||||
# Fetch the decompressed JSON data
|
||||
json_data = definitions[id_number]
|
||||
|
||||
# Name check (it is of no use if it is empty/null, so exclude)
|
||||
if json_data["name"] in SKIP_EMPTY_NAMES:
|
||||
continue
|
||||
|
||||
# Process cache definition based on type (item, npc, object)
|
||||
# Items: Have single interger model IDs
|
||||
# NPCs: Have list of interger model IDs
|
||||
# Objects: Have list of integer model IDs
|
||||
if cache_name == "items":
|
||||
extracted_models = extract_model_ids_int(json_data)
|
||||
elif cache_name == "npcs":
|
||||
extracted_models = extract_model_ids_list(json_data)
|
||||
elif cache_name == "objects":
|
||||
extracted_models = extract_model_ids_list(json_data)
|
||||
|
||||
# Add extracted models to all_models dictionary
|
||||
all_models.update(extracted_models)
|
||||
|
||||
# Save all extracted models ID numbers to JSON file
|
||||
out_fi = Path(config.DOCS_PATH / "models-summary.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(all_models, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
process()
|
||||
55
scripts/cache/update.py
vendored
Normal file
55
scripts/cache/update.py
vendored
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to update OSRS cache data dump.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from scripts.cache import generate_items_stacked_variants
|
||||
from scripts.cache import generate_items_cache_data
|
||||
from scripts.cache import generate_monsters_cache_data
|
||||
from scripts.cache import generate_summary_files
|
||||
from scripts.cache import generate_summary_models
|
||||
from scripts.cache import determine_changes
|
||||
|
||||
|
||||
def main():
|
||||
print(">>> generate_items_stacked_variants...")
|
||||
generate_items_stacked_variants.process()
|
||||
|
||||
print(">>> generate_items_cache_data...")
|
||||
generate_items_cache_data.process()
|
||||
|
||||
print(">>> generate_monsters_cache_data...")
|
||||
generate_monsters_cache_data.process()
|
||||
|
||||
print(">>> generate_summary_files...")
|
||||
generate_summary_files.process()
|
||||
|
||||
print(">>> generate_summary_models...")
|
||||
generate_summary_models.process()
|
||||
|
||||
print(">>> determine_changes...")
|
||||
determine_changes.items()
|
||||
determine_changes.monsters()
|
||||
determine_changes.move()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
51
scripts/icons/check_item_icons.py
Normal file
51
scripts/icons/check_item_icons.py
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Load the processed cache data for items, check each item for a corresponding
|
||||
icon in the docs/items-icons folder.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
|
||||
|
||||
def main():
|
||||
# Load current items-cache-data.json file
|
||||
items_cache_data_file = Path(config.DATA_ITEMS_PATH / "items-cache-data.json")
|
||||
with open(items_cache_data_file) as f:
|
||||
items_cache_data = json.load(f)
|
||||
|
||||
# Load current icons-items-complete.json file
|
||||
icons_items_file_path = Path(config.DATA_ICONS_PATH / "icons-items-complete.json")
|
||||
with open(icons_items_file_path) as f:
|
||||
icon_items = json.load(f)
|
||||
|
||||
for item_id, item_data in items_cache_data.items():
|
||||
# Check for item ID key in icon_items file
|
||||
try:
|
||||
icon_items[item_id]
|
||||
except KeyError:
|
||||
print(f" > No icon for item ID: {item_id}, {item_data['name']}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
81
scripts/icons/convert_item_icons.py
Normal file
81
scripts/icons/convert_item_icons.py
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Convert items icons to base64 and populate icons-items-complete.json file.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import base64
|
||||
import hashlib
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
|
||||
|
||||
def get_md5(file_path):
|
||||
h = hashlib.new("md5")
|
||||
with open(file_path, "rb") as file:
|
||||
block = file.read(512)
|
||||
while block:
|
||||
h.update(block)
|
||||
block = file.read(512)
|
||||
|
||||
return h.hexdigest()
|
||||
|
||||
|
||||
def main():
|
||||
# Set path for item icon files and glob PNGs
|
||||
fis = Path(config.STATICS_PATH / "items-icons").glob("*")
|
||||
|
||||
# Set output dictionary for JSON export
|
||||
all_icons = dict()
|
||||
|
||||
# Sort icon files numerically
|
||||
item_ids = [x.stem for x in fis]
|
||||
item_ids = sorted(item_ids)
|
||||
|
||||
# Loop all item IDs, and process each PNG
|
||||
for item_id in item_ids:
|
||||
# Set the image file location
|
||||
image_name = f"{item_id}" + ".png"
|
||||
image_path = Path(config.STATICS_PATH / "items-icons" / image_name)
|
||||
|
||||
# Check for default images, and remove them
|
||||
md5 = get_md5(image_path)
|
||||
if md5 == "af7f8e0df9cce2bc800d1ae9f5372d99":
|
||||
image_path.unlink()
|
||||
continue
|
||||
|
||||
# Open PNG file, and convert to Base64
|
||||
with open(image_path, "rb") as f:
|
||||
b64_data = base64.b64encode(f.read())
|
||||
b64_image = b64_data.decode()
|
||||
all_icons[item_id] = b64_image
|
||||
|
||||
# Export all converted PNG images to a JSON file to docs folder
|
||||
out = Path(config.DATA_PATH / "icons" / "icons-items-complete.json")
|
||||
os.makedirs(os.path.dirname(out), exist_ok=True)
|
||||
with open(out, "w") as f:
|
||||
json.dump(all_icons, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
61
scripts/icons/convert_prayer_icons.py
Normal file
61
scripts/icons/convert_prayer_icons.py
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Convert prayers icons to base64 and populate icons-prayers-complete.json file.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import base64
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
|
||||
|
||||
def main():
|
||||
# Set path for item icon files and glob PNGs
|
||||
fis = Path(config.DOCS_PATH / "prayers-icons").glob("*")
|
||||
|
||||
# Set output dictionary for JSON export
|
||||
all_icons = dict()
|
||||
|
||||
# Sort icon files numerically
|
||||
item_ids = [int(x.stem) for x in fis]
|
||||
item_ids = sorted(item_ids)
|
||||
|
||||
# Loop all item IDs, and process each PNG
|
||||
for item_id in item_ids:
|
||||
# Set the image file location
|
||||
image_name = f"{item_id}" + ".png"
|
||||
image_path = Path(config.DOCS_PATH / "prayers-icons" / image_name)
|
||||
|
||||
# Open PNG file, and convert to Base64
|
||||
with open(image_path, "rb") as f:
|
||||
b64_data = base64.b64encode(f.read())
|
||||
b64_image = b64_data.decode()
|
||||
all_icons[item_id] = b64_image
|
||||
|
||||
# Export all converted PNG images to a JSON file to data folder
|
||||
out = Path(config.DATA_PATH / "icons" / "icons-prayers-complete.json")
|
||||
with open(out, "w") as f:
|
||||
json.dump(all_icons, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
14
scripts/icons/remove_blanks.sh
Executable file
14
scripts/icons/remove_blanks.sh
Executable file
|
|
@ -0,0 +1,14 @@
|
|||
#!/bin/bash
|
||||
|
||||
BAD_HASH="af7f8e0df9cce2bc800d1ae9f5372d99"
|
||||
FILES="../../docs/items-icons/*"
|
||||
|
||||
for fi in $FILES
|
||||
do
|
||||
hash=$(md5sum $fi | awk '{ print $1 }')
|
||||
if [[ $hash == $BAD_HASH ]]
|
||||
then
|
||||
echo "Removing:" $fi
|
||||
rm $fi
|
||||
fi
|
||||
done
|
||||
61
scripts/items/items_buylimits.py
Normal file
61
scripts/items/items_buylimits.py
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Fetch a list of item buy limits from the OSRS Wiki.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import re
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import requests
|
||||
|
||||
import config
|
||||
|
||||
|
||||
def fetch():
|
||||
# Fetch the OSRS Wiki buy limits module data
|
||||
url = "https://oldschool.runescape.wiki/w/Module:GELimits/data?action=raw"
|
||||
|
||||
try:
|
||||
data = requests.get(url, headers=config.custom_agent).text
|
||||
except requests.exceptions.RequestException as e:
|
||||
raise SystemExit(">>> ERROR: Get request error. Exiting.") from e
|
||||
|
||||
buy_limits = dict()
|
||||
|
||||
# Parse each line, looking for following structure
|
||||
# ["3rd age amulet"] = 8,
|
||||
# Source: runelite/runelite-wiki-scraper
|
||||
for line in data.split("\n"):
|
||||
match = re.search(r"\[\"(.*)\"\] = (\d+),?", str(line))
|
||||
if match:
|
||||
name = match.group(1).replace('\\', '')
|
||||
limit = match.group(2)
|
||||
buy_limits[name] = int(limit)
|
||||
|
||||
file_name = "items-buylimits.json"
|
||||
file_path = Path(config.DATA_ITEMS_PATH / file_name)
|
||||
with open(file_path, "w") as f:
|
||||
json.dump(buy_limits, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
fetch()
|
||||
191
scripts/items/items_properties.py
Normal file
191
scripts/items/items_properties.py
Normal file
|
|
@ -0,0 +1,191 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to fetch OSRS Wiki pages for Category:Items.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import asyncio
|
||||
from typing import List
|
||||
from aiohttp_retry import RetryClient, JitterRetry
|
||||
import aiohttp
|
||||
from tqdm.asyncio import tqdm
|
||||
import os
|
||||
from pprint import pprint
|
||||
import sys
|
||||
import json
|
||||
import itertools
|
||||
import collections
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from datetime import timedelta
|
||||
|
||||
import config
|
||||
from scripts.wiki.wiki_page_titles import WikiPageTitles
|
||||
from scripts.wiki.wiki_page_text import WikiPageText
|
||||
from scripts.wiki.wikitext_parser import WikitextIDParser
|
||||
|
||||
|
||||
OSRS_WIKI_API_URL = "https://oldschool.runescape.wiki/api.php"
|
||||
TITLES_FP = Path(config.DATA_ITEMS_PATH / "items-wiki-page-titles.json")
|
||||
TEXT_FP = Path(config.DATA_ITEMS_PATH / "items-wiki-page-text.json")
|
||||
|
||||
|
||||
def fetch():
|
||||
"""Get all the wiki category page titles and page text."""
|
||||
# Try to determine the last update
|
||||
if TITLES_FP.exists():
|
||||
stream = os.popen(f"git log -1 --format='%ad' {TITLES_FP}")
|
||||
last_extraction_date = stream.read()
|
||||
last_extraction_date = last_extraction_date.strip()
|
||||
last_extraction_date = last_extraction_date.replace(" +1200", "")
|
||||
try:
|
||||
last_extraction_date = datetime.strptime(
|
||||
last_extraction_date, "%a %b %d %H:%M:%S %Y"
|
||||
)
|
||||
last_extraction_date = last_extraction_date - timedelta(days=3)
|
||||
except:
|
||||
last_extraction_date = datetime.strptime("2013-02-22", "%Y-%m-%d")
|
||||
else:
|
||||
last_extraction_date = datetime.strptime("2013-02-22", "%Y-%m-%d")
|
||||
|
||||
print(">>> Starting wiki page titles extraction...")
|
||||
# Create object to handle page titles extraction
|
||||
wiki_page_titles = WikiPageTitles(OSRS_WIKI_API_URL, ["Items", "Pets"])
|
||||
|
||||
# Boolean to trigger load page titles from file, or run fresh page title extraction
|
||||
load_files = False
|
||||
|
||||
# Load previously extracted page titles from JSON, or extract from OSRS Wiki API
|
||||
if load_files:
|
||||
loaded_page_titles = wiki_page_titles.load_page_titles(TITLES_FP)
|
||||
if not loaded_page_titles:
|
||||
sys.exit(
|
||||
">>> ERROR: Specified page titles to load, but not file found. Exiting."
|
||||
)
|
||||
else:
|
||||
# Extract page titles using supplied categories
|
||||
wiki_page_titles.extract_page_titles()
|
||||
# Extract page revision date
|
||||
# Loop 50 page titles at a time, the max number for a revisions request using page titles
|
||||
for page_title_list in itertools.zip_longest(
|
||||
*[iter(wiki_page_titles.page_titles)] * 50
|
||||
):
|
||||
# Remove None entries from the list of page titles
|
||||
page_title_list = filter(None, page_title_list)
|
||||
# Join the page titles list using the pipe (|) separator
|
||||
page_titles_string = "|".join(page_title_list)
|
||||
# Extract the page revision date
|
||||
wiki_page_titles.extract_last_revision_timestamp(page_titles_string)
|
||||
# Save all page titles and
|
||||
wiki_page_titles.export_page_titles_in_json(TITLES_FP)
|
||||
|
||||
# Determine page titles count
|
||||
page_titles_total = len(wiki_page_titles)
|
||||
print(f">>> Number of extracted wiki pages: {page_titles_total}")
|
||||
|
||||
_process_item_properties(wiki_page_titles)
|
||||
|
||||
|
||||
def _process_item_properties(a):
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(_inner_process_item_properties(a))
|
||||
|
||||
|
||||
async def _inner_process_item_properties(wiki_page_titles):
|
||||
pprint(">>> Starting wiki text extraction for extracted page titles...")
|
||||
json_data = dict()
|
||||
|
||||
conn = aiohttp.TCPConnector(limit=10)
|
||||
timeout = aiohttp.ClientTimeout(
|
||||
total=5 * 60, connect=60, sock_connect=5, sock_read=5
|
||||
)
|
||||
retry_options = JitterRetry(
|
||||
attempts=5,
|
||||
exceptions={aiohttp.client_exceptions.ServerTimeoutError},
|
||||
start_timeout=1.5,
|
||||
)
|
||||
retry_client = RetryClient(
|
||||
retry_options=retry_options,
|
||||
connector=conn,
|
||||
timeout=timeout,
|
||||
raise_for_status=False,
|
||||
)
|
||||
async with retry_client as session:
|
||||
tasks = []
|
||||
for page_title, _ in wiki_page_titles.page_titles.items():
|
||||
# If script fails:
|
||||
# 1) Set load_files (above) to True
|
||||
# 2) Uncomment code below, and set item ID to last failed item
|
||||
# 3) Use this script: python monster_properties_fetch -c Items, Pets
|
||||
# if int(page_titles_count) < 5400:
|
||||
# page_titles_count += 1
|
||||
# continue
|
||||
|
||||
# Check if page title is already present in JSON output file, also check revision date
|
||||
if page_title in json_data:
|
||||
# If the last revision was before last extract, skip
|
||||
continue
|
||||
|
||||
# Create object to extract page wiki text
|
||||
wiki_page_text = WikiPageText(OSRS_WIKI_API_URL, page_title)
|
||||
|
||||
tasks.append(
|
||||
asyncio.ensure_future(wiki_page_text.extract_page_wiki_text(session))
|
||||
)
|
||||
|
||||
d: List[WikiPageText] = await tqdm.gather(*tasks)
|
||||
|
||||
# TODO: There absolutely is a better way to do this
|
||||
for item in d:
|
||||
item.export_wiki_text_to_json(TEXT_FP)
|
||||
|
||||
|
||||
def process():
|
||||
print(">>> Starting wiki page text processing...")
|
||||
|
||||
# Call WikitextIDParser to map:
|
||||
# 1. ID to infobox template version
|
||||
# 2. ID to wikitext entry
|
||||
template_names = ["infobox item", "infobox pet"]
|
||||
wiki_data_ids = WikitextIDParser(TEXT_FP, template_names)
|
||||
wiki_data_ids.process_osrswiki_data_dump()
|
||||
|
||||
WikiEntry = collections.namedtuple(
|
||||
"WikiEntry", "wiki_page_name version_number wikitext"
|
||||
)
|
||||
|
||||
export = dict()
|
||||
|
||||
for item_id, wikitext in wiki_data_ids.item_id_to_wikitext.items():
|
||||
entry = WikiEntry(
|
||||
wiki_page_name=wiki_data_ids.item_id_to_wiki_name[item_id],
|
||||
version_number=wiki_data_ids.item_id_to_version_number[item_id],
|
||||
wikitext=wikitext,
|
||||
)
|
||||
export[item_id] = entry
|
||||
|
||||
out_fi = Path(config.DATA_ITEMS_PATH / "items-wiki-page-text-processed.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(export, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
fetch()
|
||||
process()
|
||||
54
scripts/items/items_unalchable.py
Normal file
54
scripts/items/items_unalchable.py
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Fetch a list of unalchable items from the OSRS Wiki.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from pathlib import Path
|
||||
|
||||
import config
|
||||
from scripts.wiki.wiki_page_titles import WikiPageTitles
|
||||
|
||||
OSRS_WIKI_API_URL = "https://oldschool.runescape.wiki/api.php"
|
||||
|
||||
|
||||
def fetch():
|
||||
# The first category argument, used to build the output file name
|
||||
categories = ["Items_that_cannot_be_alchemised"]
|
||||
|
||||
# Specify the name for the page titles output JSON file
|
||||
titles_file_path = "items-unalchable.json"
|
||||
titles_file_path = Path(config.DATA_ITEMS_PATH / titles_file_path)
|
||||
|
||||
print(">>> Starting wiki page titles extraction...")
|
||||
# Create object to handle page titles extraction
|
||||
wiki_page_titles = WikiPageTitles(OSRS_WIKI_API_URL,
|
||||
categories)
|
||||
|
||||
wiki_page_titles.extract_page_titles()
|
||||
wiki_page_titles.export_page_titles_in_json(titles_file_path)
|
||||
|
||||
# Determine page titles count
|
||||
page_titles_total = len(wiki_page_titles)
|
||||
print(f">>> Number of extracted wiki pages: {page_titles_total}")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
fetch()
|
||||
42
scripts/items/update.py
Normal file
42
scripts/items/update.py
Normal file
|
|
@ -0,0 +1,42 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to update all Items data.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from scripts.items import items_buylimits
|
||||
from scripts.items import items_properties
|
||||
from scripts.items import items_unalchable
|
||||
from scripts.icons import convert_item_icons
|
||||
|
||||
|
||||
def main():
|
||||
items_buylimits.fetch()
|
||||
|
||||
items_properties.fetch()
|
||||
items_properties.process()
|
||||
|
||||
items_unalchable.fetch()
|
||||
|
||||
convert_item_icons.main()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
464
scripts/monsters/monsters_drops.py
Normal file
464
scripts/monsters/monsters_drops.py
Normal file
|
|
@ -0,0 +1,464 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to fetch OSRS Wiki drops for Monsters.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import re
|
||||
import json
|
||||
from pathlib import Path
|
||||
from fractions import Fraction
|
||||
from collections import defaultdict
|
||||
import asyncio
|
||||
import aiohttp
|
||||
import aiofiles
|
||||
from aiohttp_retry import RetryClient, JitterRetry
|
||||
from tqdm.asyncio import tqdm
|
||||
|
||||
from pprint import pprint
|
||||
|
||||
import config
|
||||
from osrsbox import items_api
|
||||
from scripts.wiki.wikitext_parser import WikitextTemplateParser
|
||||
|
||||
|
||||
# Data structure for any monster with multiple drop tables
|
||||
# Format: id: query_string
|
||||
multi_drop_tables = dict()
|
||||
|
||||
ITEMS = [item for item in items_api.load() if not item.duplicate and not item.stacked]
|
||||
|
||||
|
||||
def _full_process(selection, conditions_dict):
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(_inner_full_process(selection, conditions_dict))
|
||||
|
||||
|
||||
async def _inner_full_process(selection, conditions_dict):
|
||||
api_url = "https://oldschool.runescape.wiki/api.php"
|
||||
pprint(conditions_dict)
|
||||
print(f">>> Fetching {len(conditions_dict)} drop tables...")
|
||||
|
||||
conn = aiohttp.TCPConnector(limit = 20)
|
||||
timeout = aiohttp.ClientTimeout(
|
||||
total=5 * 60, connect=60, sock_connect=5, sock_read=5
|
||||
)
|
||||
retry_options = JitterRetry(
|
||||
attempts=5,
|
||||
exceptions={aiohttp.client_exceptions.ServerTimeoutError},
|
||||
start_timeout=1.5,
|
||||
)
|
||||
retry_client = RetryClient(
|
||||
retry_options=retry_options,
|
||||
connector=conn,
|
||||
timeout=timeout,
|
||||
raise_for_status=False,
|
||||
)
|
||||
async with retry_client as session:
|
||||
tasks = []
|
||||
for condition in conditions_dict.keys():
|
||||
print(f" > Processing {condition}")
|
||||
|
||||
query = f"{condition}{selection}"
|
||||
|
||||
tasks.append(asyncio.ensure_future(_aprocess(session, condition, api_url, headers=config.custom_agent, query=query)))
|
||||
|
||||
d = await tqdm.gather(*tasks)
|
||||
datas = dict(d)
|
||||
|
||||
for condition, monster_ids in conditions_dict.items():
|
||||
for monster_id in monster_ids:
|
||||
file_name = f"{monster_id}.json"
|
||||
file_path = Path(config.DATA_MONSTERS_PATH / "monsters-drops-raw" / file_name)
|
||||
async with aiofiles.open(file_path, "w") as f:
|
||||
await f.write(json.dumps(datas[condition], indent=4))
|
||||
pprint(f"wrote {monster_id}")
|
||||
|
||||
async def _aprocess(session, condition, url, headers, query):
|
||||
params = {
|
||||
"action": "ask",
|
||||
"format": "json",
|
||||
"query": query
|
||||
}
|
||||
async with session.get(url, headers=headers, params=params) as resp:
|
||||
data = await resp.json()
|
||||
return (condition, data)
|
||||
|
||||
|
||||
def fetch():
|
||||
"""Fetch monster drops using SMW queries.
|
||||
|
||||
This is a request heavy method - querying about 1,000 endpoints
|
||||
to get monster drop data.
|
||||
"""
|
||||
# Load the monster wikitext file of processed data
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-text-processed.json")) as f:
|
||||
all_wikitext_processed = json.load(f)
|
||||
|
||||
# Load the raw cache data that has been processed (this is ground truth)
|
||||
with open(Path(config.DATA_MONSTERS_PATH / "monsters-cache-data.json")) as f:
|
||||
all_monster_cache_data = json.load(f)
|
||||
|
||||
Path(config.DATA_MONSTERS_PATH / "monsters-drops-raw").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
for monster_id, monster_list in all_wikitext_processed.items():
|
||||
exists = all_monster_cache_data.get(monster_id, None)
|
||||
if not exists:
|
||||
continue
|
||||
if "dropversion" in monster_list[2].lower():
|
||||
name = all_monster_cache_data[monster_id]["name"]
|
||||
wikitext = monster_list[2]
|
||||
version = monster_list[1]
|
||||
wikitext_template = WikitextTemplateParser(wikitext)
|
||||
wikitext_template.extract_infobox("infobox monster")
|
||||
value = wikitext_template.extract_infobox_value(f"dropversion{version}")
|
||||
if not value:
|
||||
value = wikitext_template.extract_infobox_value(f"dropversion1")
|
||||
multi_drop_tables[monster_id] = f"[[Dropped from::{name}#{value}]]"
|
||||
|
||||
# Specify what the SMW query should return
|
||||
selection = "|?Dropped item|?Drop Quantity|?Rarity|?Rolls|limit=500"
|
||||
|
||||
# Set parameters to run a SMW query
|
||||
params = {
|
||||
"action": "ask",
|
||||
"format": "json",
|
||||
"query": None
|
||||
}
|
||||
|
||||
# Data structures for storing conditions
|
||||
# Conditions are used to form the SMW query
|
||||
conditions_set = set()
|
||||
conditions_dict = defaultdict(list)
|
||||
|
||||
# Loop raw monster cache data (ground truth)
|
||||
for monster_id, monster in all_monster_cache_data.items():
|
||||
if monster_id in multi_drop_tables:
|
||||
condition = multi_drop_tables[monster_id]
|
||||
else:
|
||||
condition = f"[[Dropped from::{monster['name']}]]"
|
||||
|
||||
# Add to set of conditions to later query
|
||||
conditions_set.add(condition)
|
||||
|
||||
# Add condition string for monster ID lookup
|
||||
conditions_dict[condition].append(monster_id)
|
||||
|
||||
_full_process(selection=selection, conditions_dict=conditions_dict)
|
||||
|
||||
|
||||
def gem_drop_table(base_rarity: float) -> list:
|
||||
"""Set Gem Drop Table items.
|
||||
|
||||
Item drops are hard coded.
|
||||
Drop rates sourced from:
|
||||
https://osrs.wiki/w/Drop_table#Useful_herb_drop_table
|
||||
|
||||
:param base_rarity: The rarity for the drop table.
|
||||
:return: List of items on the drop table.
|
||||
"""
|
||||
|
||||
# Populate drop table items
|
||||
items = [
|
||||
{
|
||||
"id": 1623,
|
||||
"name": "Uncut sapphire",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/4 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1621,
|
||||
"name": "Uncut emerald",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/8 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1619,
|
||||
"name": "Uncut ruby",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/16 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1452,
|
||||
"name": "Chaos talisman",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/42.67 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1462,
|
||||
"name": "Nature talisman",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/42.67 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1617,
|
||||
"name": "Uncut diamond",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/64 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 830,
|
||||
"name": "Rune javelin",
|
||||
"members": True,
|
||||
"quantity": "5",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 987,
|
||||
"name": "Loop half of key",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 985,
|
||||
"name": "Tooth half of key",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1247,
|
||||
"name": "Rune spear",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * 1/16 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 2366,
|
||||
"name": "Shield left half",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * 1/32 * base_rarity,
|
||||
"rolls": 1
|
||||
},
|
||||
{
|
||||
"id": 1249,
|
||||
"name": "Dragon spear",
|
||||
"members": True,
|
||||
"quantity": "1",
|
||||
"noted": False,
|
||||
"rarity": 1/128 * 1/42.67 * base_rarity,
|
||||
"rolls": 1
|
||||
}
|
||||
]
|
||||
|
||||
return(items)
|
||||
|
||||
|
||||
def quantity_cleaner(quantity: str) -> str:
|
||||
"""Convert the drop quantity text entry.
|
||||
|
||||
:param quantity: The extracted raw wiki text.
|
||||
:return: A cleaned drop quantity property value.
|
||||
"""
|
||||
if quantity is None:
|
||||
return None
|
||||
|
||||
if quantity.lower() == "unknown":
|
||||
return None
|
||||
|
||||
quantity = quantity.replace(" ", "")
|
||||
quantity = quantity.replace(u"\u2013", "-")
|
||||
quantity = re.sub(r" *\(noted\) *", '', quantity)
|
||||
|
||||
# Change semi-colon seperated list of numbers to commas
|
||||
quantity = re.sub(r"[; ]", ',', quantity)
|
||||
|
||||
# Check the extracted and processed value against the supplied regex
|
||||
# Potenital format: "1-10", "1", "2,4,5"
|
||||
pattern = re.compile(r"^[0-9]*([-,][0-9]*)?")
|
||||
if quantity and not pattern.match(quantity):
|
||||
print(f">>> Drop quantity regex failed: {quantity}")
|
||||
exit(1)
|
||||
|
||||
return quantity
|
||||
|
||||
|
||||
def rarity_cleaner(rarity: str):
|
||||
if rarity.lower() == "always":
|
||||
return "1/1"
|
||||
elif rarity.lower() == "common":
|
||||
return "1/8"
|
||||
elif rarity.lower() == "uncommon":
|
||||
return "1/32"
|
||||
elif rarity.lower() == "rare":
|
||||
return "1/128"
|
||||
elif rarity.replace(" ", "").lower() == "veryrare":
|
||||
return "1/512"
|
||||
|
||||
|
||||
def item_id_lookup(name: str) -> int:
|
||||
if name == "Black mask":
|
||||
name = "Black mask (10)"
|
||||
|
||||
for item in ITEMS:
|
||||
if item.wiki_name == name:
|
||||
return item.id, item.members
|
||||
|
||||
for item in ITEMS:
|
||||
if item.name == name:
|
||||
return item.id, item.members
|
||||
|
||||
print(f" > COULD NOT FIND: {name}")
|
||||
return None, None
|
||||
|
||||
|
||||
def process_one(data: dict) -> dict:
|
||||
results = data["query"]["results"]
|
||||
drops = []
|
||||
|
||||
if not results:
|
||||
return drops
|
||||
|
||||
for query_str, printouts in results.items():
|
||||
|
||||
try:
|
||||
print(printouts)
|
||||
name = printouts["printouts"]["Dropped item"][0]["fulltext"]
|
||||
|
||||
if "#" in name:
|
||||
name = name.replace("#", "")
|
||||
except (IndexError, KeyError, ValueError):
|
||||
name = None
|
||||
|
||||
# Skip if drop has no name
|
||||
if not name:
|
||||
continue
|
||||
|
||||
# RARITY
|
||||
try:
|
||||
rarity = printouts["printouts"]["Rarity"][0]
|
||||
|
||||
# Convert string rarity to a string fraction
|
||||
if rarity.lower() in ["always", "common", "uncommon", "rare", "veryrare"]:
|
||||
rarity = rarity_cleaner(rarity)
|
||||
|
||||
# Remove thousand seperators from fractions
|
||||
rarity = rarity.replace(",", "")
|
||||
|
||||
# Split fraction for calculation
|
||||
numerator, denominator = rarity.split('/')
|
||||
|
||||
# Convert to a float - the safe way 0_o
|
||||
rarity = float(Fraction(numerator) / Fraction(denominator))
|
||||
except (IndexError, KeyError, ValueError):
|
||||
rarity = float(Fraction(1) / Fraction(512))
|
||||
|
||||
if "gem drop table" in name.lower():
|
||||
items = gem_drop_table(rarity)
|
||||
drops.extend(items)
|
||||
continue
|
||||
|
||||
if "rare drop table" in name.lower():
|
||||
continue
|
||||
|
||||
itemid, members = item_id_lookup(name)
|
||||
|
||||
# Skip if not item ID
|
||||
if not itemid:
|
||||
continue
|
||||
|
||||
# QUANTITY
|
||||
try:
|
||||
quantity = printouts["printouts"]["Drop Quantity"][0]
|
||||
quantity = quantity_cleaner(quantity)
|
||||
except (IndexError, KeyError, ValueError):
|
||||
quantity = None
|
||||
|
||||
# NOTED
|
||||
try:
|
||||
noted = "noted" in printouts["printouts"]["Drop Quantity"][0].lower()
|
||||
except (IndexError, KeyError, ValueError):
|
||||
noted = False
|
||||
|
||||
# ROLLS
|
||||
try:
|
||||
rolls = printouts["printouts"]["Rolls"][0]
|
||||
rolls = int(rolls)
|
||||
except (IndexError, KeyError, ValueError):
|
||||
rolls = 1
|
||||
|
||||
drop = {
|
||||
"id": itemid,
|
||||
"name": name,
|
||||
"members": members,
|
||||
"quantity": quantity,
|
||||
"noted": noted,
|
||||
"rarity": rarity,
|
||||
"rolls": rolls
|
||||
}
|
||||
drops.append(drop)
|
||||
|
||||
return drops
|
||||
|
||||
|
||||
def process():
|
||||
print(">>> Processing monster drops...")
|
||||
|
||||
fis = Path(config.DATA_MONSTERS_PATH / "monsters-drops-raw").glob("*.json")
|
||||
|
||||
all_monster_drops = dict()
|
||||
|
||||
file_name = "monsters-drops.json"
|
||||
file_path = Path(config.DATA_MONSTERS_PATH / file_name)
|
||||
|
||||
for fi in fis:
|
||||
with open(fi) as f:
|
||||
raw_data = json.load(f)
|
||||
|
||||
processed_data = process_one(raw_data)
|
||||
monster_id = int(fi.stem)
|
||||
all_monster_drops[monster_id] = processed_data
|
||||
|
||||
with open(file_path, "w") as f:
|
||||
json.dump(all_monster_drops, f)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
fetch()
|
||||
process()
|
||||
188
scripts/monsters/monsters_properties.py
Normal file
188
scripts/monsters/monsters_properties.py
Normal file
|
|
@ -0,0 +1,188 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to fetch OSRS Wiki pages for Category:Monsters.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from aiohttp_retry import RetryClient, JitterRetry
|
||||
from tqdm.asyncio import tqdm
|
||||
import os
|
||||
from pprint import pprint
|
||||
import sys
|
||||
import json
|
||||
import itertools
|
||||
import collections
|
||||
from pathlib import Path
|
||||
from datetime import datetime
|
||||
from datetime import timedelta
|
||||
from typing import List
|
||||
import aiohttp
|
||||
|
||||
import config
|
||||
from scripts.wiki.wiki_page_titles import WikiPageTitles
|
||||
from scripts.wiki.wiki_page_text import WikiPageText
|
||||
from scripts.wiki.wikitext_parser import WikitextIDParser
|
||||
|
||||
|
||||
OSRS_WIKI_API_URL = "https://oldschool.runescape.wiki/api.php"
|
||||
TITLES_FP = Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-titles.json")
|
||||
TEXT_FP = Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-text.json")
|
||||
|
||||
|
||||
def fetch():
|
||||
"""Get all the wiki category page titles and page text."""
|
||||
# Try to determine the last update
|
||||
if TITLES_FP.exists():
|
||||
stream = os.popen(f"git log -1 --format='%ad' {TITLES_FP}")
|
||||
last_extraction_date = stream.read()
|
||||
last_extraction_date = last_extraction_date.strip()
|
||||
last_extraction_date = last_extraction_date.replace(" -0500", "")
|
||||
try:
|
||||
last_extraction_date = datetime.strptime(last_extraction_date, "%a %b %d %H:%M:%S %Y")
|
||||
last_extraction_date = last_extraction_date - timedelta(days=3)
|
||||
except:
|
||||
last_extraction_date = datetime.strptime("2013-02-22", "%Y-%m-%d")
|
||||
else:
|
||||
last_extraction_date = datetime.strptime("2013-02-22", "%Y-%m-%d")
|
||||
|
||||
print(">>> Starting wiki page titles extraction...")
|
||||
# Create object to handle page titles extraction
|
||||
wiki_page_titles = WikiPageTitles(OSRS_WIKI_API_URL,
|
||||
["Monsters"])
|
||||
|
||||
# Boolean to trigger load page titles from file, or run fresh page title extraction
|
||||
load_files = False
|
||||
|
||||
# Load previously extracted page titles from JSON, or extract from OSRS Wiki API
|
||||
if load_files:
|
||||
loaded_page_titles = wiki_page_titles.load_page_titles(TITLES_FP)
|
||||
if not loaded_page_titles:
|
||||
sys.exit(">>> ERROR: Specified page titles to load, but not file found. Exiting.")
|
||||
else:
|
||||
# Extract page titles using supplied categories
|
||||
wiki_page_titles.extract_page_titles()
|
||||
# Extract page revision date
|
||||
# Loop 50 page titles at a time, the max number for a revisions request using page titles
|
||||
for page_title_list in itertools.zip_longest(*[iter(wiki_page_titles.page_titles)] * 50):
|
||||
# Remove None entries from the list of page titles
|
||||
page_title_list = filter(None, page_title_list)
|
||||
# Join the page titles list using the pipe (|) separator
|
||||
page_titles_string = "|".join(page_title_list)
|
||||
# Extract the page revision date
|
||||
wiki_page_titles.extract_last_revision_timestamp(page_titles_string)
|
||||
# Save all page titles and
|
||||
wiki_page_titles.export_page_titles_in_json(TITLES_FP)
|
||||
|
||||
# Determine page titles count
|
||||
page_titles_total = len(wiki_page_titles)
|
||||
print(f">>> Number of extracted wiki pages: {page_titles_total}")
|
||||
|
||||
# Open page title JSON file, to check if page needs to have wiki text extracted
|
||||
|
||||
_process_monster_properties(wiki_page_titles)
|
||||
|
||||
|
||||
def _process_monster_properties(a):
|
||||
loop = asyncio.get_event_loop()
|
||||
loop.run_until_complete(_inner_process_monster_properties(a))
|
||||
|
||||
|
||||
async def _inner_process_monster_properties(wiki_page_titles):
|
||||
pprint(">>> Starting wiki text extraction for extracted page titles...")
|
||||
json_data = dict()
|
||||
|
||||
conn = aiohttp.TCPConnector(limit = 20)
|
||||
timeout = aiohttp.ClientTimeout(
|
||||
total=5 * 60, connect=60, sock_connect=5, sock_read=5
|
||||
)
|
||||
retry_options = JitterRetry(
|
||||
attempts=5,
|
||||
exceptions={aiohttp.client_exceptions.ServerTimeoutError},
|
||||
start_timeout=1.5,
|
||||
)
|
||||
retry_client = RetryClient(
|
||||
retry_options=retry_options,
|
||||
connector=conn,
|
||||
timeout=timeout,
|
||||
raise_for_status=False,
|
||||
)
|
||||
async with retry_client as session:
|
||||
tasks = []
|
||||
for page_title, _ in wiki_page_titles.page_titles.items():
|
||||
# If script fails:
|
||||
# 1) Set load_files (above) to True
|
||||
# 2) Uncomment code below, and set item ID to last failed item
|
||||
# 3) Use this script: python monster_properties_fetch -c Monsters
|
||||
# if int(page_titles_count) < 5400:
|
||||
# page_titles_count += 1
|
||||
# continue
|
||||
|
||||
# Check if page title is already present in JSON output file, also check revision date
|
||||
if page_title in json_data:
|
||||
# If the last revision was before last extract, skip
|
||||
continue
|
||||
|
||||
# Create object to extract page wiki text
|
||||
wiki_page_text = WikiPageText(OSRS_WIKI_API_URL,
|
||||
page_title)
|
||||
|
||||
# If the page title has not been extracted, extract wiki text and save to JSON file
|
||||
tasks.append(asyncio.ensure_future(wiki_page_text.extract_page_wiki_text(session)))
|
||||
|
||||
d: List[WikiPageText] = await tqdm.gather(*tasks)
|
||||
|
||||
for item in d:
|
||||
item.export_wiki_text_to_json(TEXT_FP)
|
||||
|
||||
# tasks = []
|
||||
# for item in d:
|
||||
# tasks.append(asyncio.ensure_future(item.async_export_wiki_text_to_json(TEXT_FP)))
|
||||
|
||||
# await asyncio.gather(*tasks)
|
||||
|
||||
def process():
|
||||
print(">>> Starting wiki page text processing...")
|
||||
# Call WikitextIDParser to map:
|
||||
# 1. ID to infobox template version
|
||||
# 2. ID to wikitext entry
|
||||
template_names = ["infobox monster"]
|
||||
wiki_data_ids = WikitextIDParser(TEXT_FP, template_names)
|
||||
wiki_data_ids.process_osrswiki_data_dump()
|
||||
|
||||
WikiEntry = collections.namedtuple('WikiEntry', 'wiki_page_name version_number wikitext')
|
||||
|
||||
export = dict()
|
||||
|
||||
for item_id, wikitext in wiki_data_ids.item_id_to_wikitext.items():
|
||||
entry = WikiEntry(wiki_page_name=wiki_data_ids.item_id_to_wiki_name[item_id],
|
||||
version_number=wiki_data_ids.item_id_to_version_number[item_id],
|
||||
wikitext=wikitext)
|
||||
export[item_id] = entry
|
||||
|
||||
out_fi = Path(config.DATA_MONSTERS_PATH / "monsters-wiki-page-text-processed.json")
|
||||
with open(out_fi, 'w') as f:
|
||||
json.dump(export, f, indent=4)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
fetch()
|
||||
process()
|
||||
37
scripts/monsters/update.py
Normal file
37
scripts/monsters/update.py
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to update all Monster data.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from scripts.monsters import monsters_properties
|
||||
from scripts.monsters import monsters_drops
|
||||
|
||||
|
||||
def main():
|
||||
monsters_properties.fetch()
|
||||
monsters_properties.process()
|
||||
|
||||
monsters_drops.fetch()
|
||||
monsters_drops.process()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
32
scripts/update/1_project.sh
Executable file
32
scripts/update/1_project.sh
Executable file
|
|
@ -0,0 +1,32 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Update project repo and submodules.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(git rev-parse --show-toplevel)
|
||||
|
||||
cd $odb
|
||||
|
||||
echo -e ">>> Updating repo..."
|
||||
git pull
|
||||
|
||||
echo -e ">>> Updating repo submodules..."
|
||||
git submodule update --recursive --remote
|
||||
81
scripts/update/2_cache.sh
Executable file
81
scripts/update/2_cache.sh
Executable file
|
|
@ -0,0 +1,81 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Update flatcache and extract cache data.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(git rev-parse --show-toplevel)
|
||||
rl=$(echo "${odb}/runelite")
|
||||
|
||||
set -x
|
||||
|
||||
if ! command -v java mvn &> /dev/null; then
|
||||
echo "Need java and maven"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo -e ">>> flatcache..."
|
||||
echo -e " > Building osrs-flatcache..."
|
||||
cd $odb/data/cache/osrs-flatcache
|
||||
mvn clean
|
||||
mvn install -Dcheckstyle.skip=false
|
||||
|
||||
# Find the packer.jar file with current version and bundled with dependencies
|
||||
# For example: packer-1.6.10-shaded.jar
|
||||
cd packer/target
|
||||
jar_file=$(ls | grep .shaded.jar)
|
||||
|
||||
echo -e " > Extracting osrs-cache..."
|
||||
rm -rf $odb/data/cache/cache-data
|
||||
mkdir -p $odb/data/cache/cache-data
|
||||
java -jar $jar_file unpack $odb/data/cache/osrs-cache $odb/data/cache/cache-data
|
||||
|
||||
echo -e ">>> runelite..."
|
||||
cd $rl
|
||||
git pull
|
||||
|
||||
echo -e " > Building RuneLite..."
|
||||
mvn clean
|
||||
mvn install -DskipTests
|
||||
|
||||
# Find the cache.jar file with current version and bundled with dependencies
|
||||
# For example: cache-1.5.27-SNAPSHOT-jar-with-dependencies.jar
|
||||
cd $rl/cache/target
|
||||
jar_file=$(ls | grep .jar-with-dependencies.)
|
||||
|
||||
# Remove old cache dumps
|
||||
echo -e " > Removing the old cache dump in osrsbox-db..."
|
||||
rm -r $odb/data/cache/items/
|
||||
rm -r $odb/data/cache/npcs/
|
||||
rm -r $odb/data/cache/objects/
|
||||
|
||||
# Dump the cache
|
||||
echo -e " > Dumping cache using RuneLite cache tool..."
|
||||
java -classpath $jar_file net.runelite.cache.Cache \
|
||||
-cache $odb/data/cache/cache-data \
|
||||
-items $odb/data/cache/items
|
||||
|
||||
java -classpath $jar_file net.runelite.cache.Cache \
|
||||
-cache $odb/data/cache/cache-data \
|
||||
-npcs $odb/data/cache/npcs
|
||||
|
||||
java -classpath $jar_file net.runelite.cache.Cache \
|
||||
-cache $odb/data/cache/cache-data \
|
||||
-objects $odb/data/cache/objects
|
||||
44
scripts/update/3_data.sh
Executable file
44
scripts/update/3_data.sh
Executable file
|
|
@ -0,0 +1,44 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Process cache data, then fetch wiki data.
|
||||
|
||||
Copyright (c) 2020, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(git rev-parse --show-toplevel)
|
||||
|
||||
echo -e ">>> Updating project data..."
|
||||
cd $odb
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
|
||||
echo -e " > cache..."
|
||||
cd $odb/scripts/cache
|
||||
python3 update.py
|
||||
|
||||
echo -e " > items..."
|
||||
cd $odb/scripts/items
|
||||
python3 update.py
|
||||
cd $odb/scripts/icons
|
||||
python3 convert_item_icons.py
|
||||
|
||||
echo -e " > monsters..."
|
||||
cd $odb/scripts/monsters
|
||||
python3 update.py
|
||||
38
scripts/update/4_builders_test.sh
Executable file
38
scripts/update/4_builders_test.sh
Executable file
|
|
@ -0,0 +1,38 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Run the builders.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(cd ../..; pwd)
|
||||
|
||||
export PYTHONPATH="$(dirname "$(dirname "$(pwd)")")"
|
||||
|
||||
cd $odb
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
echo -e ">>> Testing item database builder"
|
||||
cd $odb/builders/items/
|
||||
python3 builder.py --test=True
|
||||
|
||||
echo -e ">>> Testing monster database builder"
|
||||
cd $odb/builders/monsters/
|
||||
python3 builder.py --test=True
|
||||
40
scripts/update/5_builders_run.sh
Executable file
40
scripts/update/5_builders_run.sh
Executable file
|
|
@ -0,0 +1,40 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Run the builders.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(cd ../..; pwd)
|
||||
|
||||
export PYTHONPATH="$(dirname "$(dirname "$(pwd)")")"
|
||||
|
||||
cd $odb
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
echo -e ">>> Updating item database"
|
||||
rm $odb/docs/items-json/*
|
||||
cd $odb/builders/items/
|
||||
python3 builder.py --export=True
|
||||
|
||||
echo -e ">>> Updating monster database"
|
||||
rm $odb/docs/monsters-json/*
|
||||
cd $odb/builders/monsters/
|
||||
python3 builder.py --export=True
|
||||
39
scripts/update/6_update.sh
Executable file
39
scripts/update/6_update.sh
Executable file
|
|
@ -0,0 +1,39 @@
|
|||
#!/bin/bash
|
||||
: '
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Update files and run tests.
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
'
|
||||
odb=$(cd ../..; pwd)
|
||||
|
||||
export PYTHONPATH="$(dirname "$(dirname "$(pwd)")")"
|
||||
|
||||
cd $odb
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
|
||||
echo -e ">>> Running JSON population scripts..."
|
||||
cd $odb/scripts/update/
|
||||
python3 update_json_files.py
|
||||
|
||||
echo -e ">>> Running repo tests..."
|
||||
cd $odb
|
||||
python3 -m flake8
|
||||
python3 -m pytest test
|
||||
194
scripts/update/update_json_files.py
Executable file
194
scripts/update/update_json_files.py
Executable file
|
|
@ -0,0 +1,194 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
Script to update JSON files.
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import collections
|
||||
import os
|
||||
from pathlib import Path
|
||||
import argparse
|
||||
|
||||
import config
|
||||
from osrsbox import items_api
|
||||
from osrsbox import monsters_api
|
||||
from osrsbox import prayers_api
|
||||
|
||||
|
||||
def generate_items_complete():
|
||||
"""Generate the `docs/items-complete.json` file."""
|
||||
# Read in the item database content
|
||||
path_to_items_json = Path(config.DOCS_PATH / "items-json")
|
||||
all_db_items = items_api.all_items.AllItems(path_to_items_json)
|
||||
|
||||
items = {}
|
||||
|
||||
for item in all_db_items:
|
||||
json_out = item.construct_json()
|
||||
items[item.id] = json_out
|
||||
|
||||
# Save all items to docs/items_complete.json
|
||||
out_fi = Path(config.DOCS_PATH / "items-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(items, f)
|
||||
|
||||
# Save all items to osrsbox/docs/items_complete.json
|
||||
out_fi = Path(config.PACKAGE_PATH / "docs" / "items-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(items, f)
|
||||
|
||||
|
||||
def generate_item_slot_files():
|
||||
"""Generate the `docs/items-slot/` JSON files."""
|
||||
# Read in the item database content
|
||||
all_db_items = items_api.load()
|
||||
|
||||
items = collections.defaultdict(list)
|
||||
|
||||
# Fetch every equipable item with an item slot value
|
||||
for item in all_db_items:
|
||||
if item.equipable_by_player:
|
||||
items[item.equipment.slot].append(item)
|
||||
|
||||
# Process each item found, and add to an individual file for each equipment slot
|
||||
for slot in items:
|
||||
json_out = {}
|
||||
for item in items[slot]:
|
||||
json_out_temp = item.construct_json()
|
||||
json_out[item.id] = json_out_temp
|
||||
out_fi = Path(config.DOCS_PATH / "items-json-slot" / f"items-{slot}.json")
|
||||
os.makedirs(os.path.dirname(out_fi), exist_ok=True)
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(json_out, f)
|
||||
|
||||
|
||||
def generate_monsters_complete():
|
||||
"""Generate the `docs/monsters-complete.json` file."""
|
||||
# Read in the monster database content
|
||||
path_to_monsters_json = Path(config.DOCS_PATH / "monsters-json")
|
||||
all_db_monsters = monsters_api.all_monsters.AllMonsters(path_to_monsters_json)
|
||||
|
||||
monsters = {}
|
||||
|
||||
for monster in all_db_monsters:
|
||||
json_out = monster.construct_json()
|
||||
monsters[monster.id] = json_out
|
||||
|
||||
# Save all monsters to docs/monsters-complete.json
|
||||
out_fi = Path(config.DOCS_PATH / "monsters-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(monsters, f)
|
||||
|
||||
# Save all monsters to osrsbox/docs/monsters-complete.json
|
||||
out_fi = Path(config.PACKAGE_PATH / "docs" / "monsters-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(monsters, f)
|
||||
|
||||
|
||||
def generate_prayers_complete():
|
||||
"""Generate the `docs/prayers-complete.json` file."""
|
||||
# Read in the item database content
|
||||
path_to_prayers_json = Path(config.DOCS_PATH / "prayers-json")
|
||||
all_db_prayers = prayers_api.all_prayers.AllPrayers(path_to_prayers_json)
|
||||
|
||||
prayers = {}
|
||||
|
||||
for prayer in all_db_prayers:
|
||||
json_out = prayer.construct_json()
|
||||
prayers[prayer.id] = json_out
|
||||
|
||||
# Save all prayers to docs/prayers-complete.json
|
||||
out_fi = Path(config.DOCS_PATH / "prayers-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(prayers, f)
|
||||
|
||||
# Save all prayers to osrsbox/docs/prayers-complete.json
|
||||
out_fi = Path(config.PACKAGE_PATH / "docs" / "prayers-complete.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(prayers, f)
|
||||
|
||||
|
||||
def generate_items_search_file():
|
||||
"""Generate the `docs/items-search.json` file."""
|
||||
# Read in the item database content
|
||||
path_to_items_json = Path(config.DOCS_PATH / "items-json")
|
||||
all_db_items = items_api.all_items.AllItems(path_to_items_json)
|
||||
|
||||
items_search = {}
|
||||
|
||||
for item in all_db_items:
|
||||
# Make a temporary dictionary for each item
|
||||
temp_dict = dict()
|
||||
|
||||
# Add id, name, type and duplicate status
|
||||
temp_dict["id"] = item.id
|
||||
temp_dict["name"] = item.name
|
||||
temp_dict["type"] = None
|
||||
if item.noted:
|
||||
temp_dict["type"] = "noted"
|
||||
elif item.placeholder:
|
||||
temp_dict["type"] = "placeholder"
|
||||
else:
|
||||
temp_dict["type"] = "normal"
|
||||
temp_dict["duplicate"] = item.duplicate
|
||||
|
||||
# Add temp_dict to all items
|
||||
items_search[item.id] = temp_dict
|
||||
|
||||
# Save search file to docs/items_complete.json
|
||||
out_fi = Path(config.DOCS_PATH / "items-search.json")
|
||||
with open(out_fi, "w") as f:
|
||||
json.dump(items_search, f, indent=4)
|
||||
|
||||
|
||||
def main(args):
|
||||
"""The main function for generating the static JSON files."""
|
||||
if args.items:
|
||||
print("Generating items-complete.json file...")
|
||||
generate_items_complete()
|
||||
print("Generating items-json-slot JSON files...")
|
||||
generate_item_slot_files()
|
||||
print("Generating items-search.json file...")
|
||||
generate_items_search_file()
|
||||
if args.monsters:
|
||||
print("Generating monsters-complete.json file...")
|
||||
generate_monsters_complete()
|
||||
if args.prayers:
|
||||
print("Generating prayers-complete.json file...")
|
||||
generate_prayers_complete()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('--monsters',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to generate monsters.')
|
||||
parser.add_argument('--items',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to generate items.')
|
||||
parser.add_argument('--prayers',
|
||||
default=False,
|
||||
required=False,
|
||||
help='A boolean of whether to generate prayers.')
|
||||
args = parser.parse_args()
|
||||
main(args)
|
||||
136
scripts/wiki/wiki_page_text.py
Normal file
136
scripts/wiki/wiki_page_text.py
Normal file
|
|
@ -0,0 +1,136 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
from base64 import decode
|
||||
import json
|
||||
import logging
|
||||
from pprint import pprint
|
||||
import aiofiles
|
||||
from pathlib import Path
|
||||
from typing import TypeVar
|
||||
|
||||
import config
|
||||
|
||||
LOG = logging.getLogger(__name__)
|
||||
|
||||
SelfWikiPageText = TypeVar("SelfWikiPageText", bound="WikiPageText")
|
||||
|
||||
|
||||
class WikiPageText:
|
||||
"""This class handles extraction of wiki text using an OSRS Wiki API query.
|
||||
|
||||
:param base_url: The OSRS Wiki URL used for API queries.
|
||||
:param page_title: OSRS Wiki page titles used for API query.
|
||||
"""
|
||||
def __init__(self, base_url: str, page_title: str):
|
||||
self.base_url = base_url
|
||||
self.page_title = page_title
|
||||
self.wiki_text = None
|
||||
|
||||
async def extract_page_wiki_text(self, session) -> SelfWikiPageText:
|
||||
"""Extract wiki text from OSRS Wiki for a provided page name.
|
||||
|
||||
This function uses the class attributes as input to query the OSRS Wiki
|
||||
API and extract the wiki text for a specific page. The page to query is
|
||||
determined by the page title.
|
||||
"""
|
||||
request = {
|
||||
"action": "parse",
|
||||
"prop": "wikitext",
|
||||
"format": "json",
|
||||
"page": self.page_title
|
||||
}
|
||||
|
||||
pprint(f"Processing: {self.page_title}")
|
||||
# Perform HTTP GET request
|
||||
async with session.get(self.base_url, headers=config.custom_agent, params=request) as resp:
|
||||
try:
|
||||
data = await resp.json()
|
||||
except json.decoder.JSONDecodeError:
|
||||
pprint(f"Didn't get anything useful: {await resp.text()}")
|
||||
|
||||
try:
|
||||
# Try to extract the wiki text from the HTTP response
|
||||
wiki_text = data["parse"]["wikitext"]["*"]
|
||||
except KeyError:
|
||||
# Set to None if wiki text extraction failed
|
||||
wiki_text = None
|
||||
|
||||
self.wiki_text = wiki_text
|
||||
return self
|
||||
|
||||
async def async_export_wiki_text_to_json(self, out_file_name: str):
|
||||
"""Export all extracted wiki text to a JSON file.
|
||||
|
||||
Querying the OSRS Wiki constantly is a bad approach. This function writes any
|
||||
extracted wiki text to a file to save re-querying the API. This function
|
||||
attempts to overwrite pre-existing wiki text entry in a file, where the key
|
||||
is the page title, and the value is the wiki text.
|
||||
|
||||
:param out_file_name: The file name to save wiki text to.
|
||||
"""
|
||||
# Create dictionary for export
|
||||
json_data = {self.page_title: str(self.wiki_text)}
|
||||
|
||||
out_file_name = Path(out_file_name)
|
||||
|
||||
pprint(f"{json_data}")
|
||||
# Write dictionary to JSON file
|
||||
if not out_file_name.exists():
|
||||
async with aiofiles.open(out_file_name, mode='w') as out_file:
|
||||
await out_file.write(json.dumps(json_data, indent=4))
|
||||
else:
|
||||
async with aiofiles.open(out_file_name) as feeds_json:
|
||||
contents = await feeds_json.read()
|
||||
try:
|
||||
feeds = json.loads(contents)
|
||||
except json.decoder.json.JSONDecodeError:
|
||||
pprint(f"{self.page_title} - {self.wiki_text}")
|
||||
|
||||
feeds[self.page_title] = str(self.wiki_text)
|
||||
async with open(out_file_name, mode='w') as out_file:
|
||||
await out_file.write(json.dumps(feeds, indent=4))
|
||||
|
||||
def export_wiki_text_to_json(self, out_file_name: str):
|
||||
"""Export all extracted wiki text to a JSON file.
|
||||
|
||||
Querying the OSRS Wiki constantly is a bad approach. This function writes any
|
||||
extracted wiki text to a file to save re-querying the API. This function
|
||||
attempts to overwrite pre-existing wiki text entry in a file, where the key
|
||||
is the page title, and the value is the wiki text.
|
||||
|
||||
:param out_file_name: The file name to save wiki text to.
|
||||
"""
|
||||
# Create dictionary for export
|
||||
json_data = {self.page_title: str(self.wiki_text)}
|
||||
|
||||
out_file_name = Path(out_file_name)
|
||||
|
||||
pprint(f"Writing {self.page_title}")
|
||||
# Write dictionary to JSON file
|
||||
if not out_file_name.exists():
|
||||
with open(out_file_name, mode='w') as out_file:
|
||||
out_file.write(json.dumps(json_data, indent=4))
|
||||
else:
|
||||
with open(out_file_name) as feeds_json:
|
||||
feeds = json.load(feeds_json)
|
||||
feeds[self.page_title] = str(self.wiki_text)
|
||||
with open(out_file_name, mode='w') as out_file:
|
||||
out_file.write(json.dumps(feeds, indent=4))
|
||||
225
scripts/wiki/wiki_page_titles.py
Normal file
225
scripts/wiki/wiki_page_titles.py
Normal file
|
|
@ -0,0 +1,225 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Copyright (c) 2019, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import Dict
|
||||
from typing import Generator
|
||||
|
||||
import requests
|
||||
|
||||
import config
|
||||
|
||||
LOG = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class WikiPageTitles:
|
||||
"""This class handles extraction of wiki page titles by category using an OSRS Wiki API query.
|
||||
|
||||
:param base_url: The OSRS Wiki URL used for API queries.
|
||||
:param categories: A list of OSRS Wiki categories.
|
||||
"""
|
||||
def __init__(self, base_url: str, categories: list):
|
||||
self.base_url = base_url
|
||||
self.categories = categories
|
||||
self.page_titles: Dict[str, str] = dict()
|
||||
|
||||
def __iter__(self) -> Generator[str, None, None]:
|
||||
"""Iterate (loop) over the extracted or loaded OSRS Wiki page titles.
|
||||
|
||||
:return: An extracted page title from the OSRS Wiki for a specific category.
|
||||
"""
|
||||
for page_title in self.page_titles:
|
||||
yield page_title
|
||||
|
||||
def __len__(self) -> int:
|
||||
"""Return the length of the extract or loaded OSRS Wiki page titles.
|
||||
|
||||
:return: The number of extracted or loaded page titles.
|
||||
"""
|
||||
return len(self.page_titles)
|
||||
|
||||
def __getitem__(self, key: str) -> str:
|
||||
"""Return the revision date of the provided page title.
|
||||
|
||||
:param key: The page title to extract the revision date from.
|
||||
:return last_revision_date: The date the page was last modified in a string ISO8601 format.
|
||||
:rtype str:
|
||||
"""
|
||||
return self.page_titles[key]
|
||||
|
||||
def load_page_titles(self, in_file_name: str) -> bool:
|
||||
"""Load a JSON file of OSRS Wiki page titles that have previously been extracted.
|
||||
|
||||
If you already have a recently dumped JSON file of OSRS Wiki page titles you
|
||||
can load them using this function. This saves performing additional wiki API
|
||||
queries when you have an up-to-date list of page titles.
|
||||
|
||||
:param in_file_name: The name of the file to load page titles from.
|
||||
:return: A boolean to indicate if a file with page titles was loaded correctly.
|
||||
"""
|
||||
if not Path.exists(in_file_name):
|
||||
return False
|
||||
with open(in_file_name) as input_json_file:
|
||||
self.page_titles = json.load(input_json_file)
|
||||
return True
|
||||
|
||||
def extract_page_titles(self):
|
||||
"""Query a list of categories in the OSRS Wiki and return a list of page titles.
|
||||
|
||||
This function is used to loop the list of categories that you want to extract
|
||||
from the OSRS Wiki using the MediaWiki API. You can all it using one category,
|
||||
for example: `Items`. Or you can use a list of category strings, for example:
|
||||
`Items, Pets, Furniture`.
|
||||
"""
|
||||
for category in self.categories:
|
||||
self.extract_page_titles_from_category(category)
|
||||
|
||||
def extract_page_titles_from_category(self, category: str):
|
||||
"""Query a specific category in the OSRS Wiki and populate a list of page tiles.
|
||||
|
||||
A function to extract all page titles from a provided OSRS Wiki category. The
|
||||
extracted page title is useful to perform additional API queries, such as
|
||||
extracting wiki text or revision timestamps.
|
||||
|
||||
:param category: A string representing the OSRS Wiki category to extract.
|
||||
"""
|
||||
# Start construct MediaWiki request
|
||||
request = {'list': 'categorymembers'}
|
||||
|
||||
for result in self._extract_page_titles_from_category_callback(request, category):
|
||||
# Process JSON result data
|
||||
for entry in result['categorymembers']:
|
||||
page_title = entry["title"]
|
||||
if page_title.startswith("File:"):
|
||||
continue
|
||||
if page_title.startswith("Category:"):
|
||||
continue
|
||||
|
||||
# Log the page title, and append to list
|
||||
self.page_titles[page_title] = None
|
||||
|
||||
def _extract_page_titles_from_category_callback(self, request: Dict, category: str):
|
||||
"""Query callback function for OSRS Wiki category query.
|
||||
|
||||
A callback function for using MediaWiki generators. Since the category query is a
|
||||
list function, you can use a generator to continue queries when the returned data
|
||||
is longer than the maximum returned query.
|
||||
|
||||
:param request: A dictionary to be populated with the OSRS Wiki API request.
|
||||
:param category: A string representing the OSRS Wiki category to extract.
|
||||
"""
|
||||
request['cmtitle'] = f'Category:{category}'
|
||||
request['action'] = 'query'
|
||||
request['format'] = 'json'
|
||||
request['cmlimit'] = '500'
|
||||
|
||||
last_continue = {}
|
||||
|
||||
while True:
|
||||
# Clone original request
|
||||
req = request.copy()
|
||||
|
||||
# Insert the 'continue' section to the request
|
||||
req.update(last_continue)
|
||||
|
||||
# Perform HTTP GET request
|
||||
try:
|
||||
result = requests.get(self.base_url,
|
||||
headers=config.custom_agent,
|
||||
params=req).json()
|
||||
except requests.exceptions.RequestException as e:
|
||||
raise SystemExit(">>> ERROR: Get request error. Exiting.") from e
|
||||
|
||||
# Handle HTTP response
|
||||
if 'query' in result:
|
||||
# If "query" entry is in JSON result, extract the query response
|
||||
yield result['query']
|
||||
if 'continue' not in result:
|
||||
# If "continue" entry is not JSON result, there are no more page titles in category
|
||||
break
|
||||
if 'errors' in result:
|
||||
print(result['errors'])
|
||||
break
|
||||
if 'warnings' in result:
|
||||
print(result['warnings'])
|
||||
break
|
||||
|
||||
# Update the last fetched page title to continue query
|
||||
last_continue = result['continue']
|
||||
|
||||
def extract_last_revision_timestamp(self, page_titles_string: str) -> Dict:
|
||||
"""Extract the last revision timestamp for page titles from OSRS Wiki.
|
||||
|
||||
The MediaWiki API used by the OSRS Wiki has the functionality to return the
|
||||
last revision date of a specific page. This function extracts the revision
|
||||
date for a list of extracted page titles. This value can be used to determine
|
||||
if changes have recently been made to the page, and if the page should be
|
||||
processed again. The input page_titles_string needs to be a list of page
|
||||
titles separated by the pipe (|) character. The maximum number of page titles
|
||||
is 50 per API query.
|
||||
|
||||
:param page_titles_string: A string of pipe separated wiki page titles.
|
||||
:return pages_revision_data:
|
||||
"""
|
||||
# Construct query for fetching page revisions
|
||||
request = {
|
||||
'action': 'query',
|
||||
'prop': 'revisions',
|
||||
'titles': page_titles_string,
|
||||
'format': 'json',
|
||||
'rvprop': 'timestamp'
|
||||
}
|
||||
|
||||
page_data = requests.get(self.base_url,
|
||||
headers=config.custom_agent,
|
||||
params=request).json()
|
||||
|
||||
# Loop returned page revision data
|
||||
pages_revision_data = page_data["query"]["pages"]
|
||||
for page_id in pages_revision_data:
|
||||
# Extract page title from the response
|
||||
page_title = pages_revision_data[page_id]["title"]
|
||||
# Extract last revision timestamp (ISO 8601 format)
|
||||
page_revision_date = pages_revision_data[page_id]["revisions"][0]["timestamp"]
|
||||
# Add revision date to page_titles dict
|
||||
self.page_titles[page_title] = page_revision_date
|
||||
|
||||
return pages_revision_data
|
||||
|
||||
def export_page_titles_in_json(self, out_file_name: str):
|
||||
"""Export all extracted page titles and revision timestamp to a JSON file.
|
||||
|
||||
:param out_file_name: The file name used for exporting the wiki page titles to JSON.
|
||||
"""
|
||||
os.makedirs(os.path.dirname(out_file_name), exist_ok=True)
|
||||
with open(out_file_name, mode='w') as out_file:
|
||||
out_file.write(json.dumps(self.page_titles, indent=4))
|
||||
|
||||
def export_page_titles_in_text(self, out_file_name: str):
|
||||
"""Export all extracted page titles from a category to a text file.
|
||||
|
||||
:param out_file_name: The file name used for exporting the wiki page titles to a text file.
|
||||
"""
|
||||
with open(out_file_name, mode='w', newline='\n') as out_file:
|
||||
for page_title in self.page_titles:
|
||||
out_file.write(page_title + '\n')
|
||||
375
scripts/wiki/wikitext_parser.py
Normal file
375
scripts/wiki/wikitext_parser.py
Normal file
|
|
@ -0,0 +1,375 @@
|
|||
"""
|
||||
Author: PH01L
|
||||
Email: phoil@osrsbox.com
|
||||
Website: https://www.osrsbox.com
|
||||
|
||||
Description:
|
||||
A module to ease parsing and extraction of data from a single OSRS Wiki page,
|
||||
or multiple wiki pages (e.g., an API data dump).
|
||||
|
||||
This module has multiple helpers methods, as well as classes. A brief summary
|
||||
for each major task is provided below:
|
||||
|
||||
1) extract_wikitext_template: A function to extract a template (usually an infobox)
|
||||
from raw wikitext. Example usage:
|
||||
extracted_templates = extract_wikitext_template(wikitext, "infobox item")
|
||||
Returns a list of extracted templates, in mwparserfromhell format
|
||||
|
||||
2) WikitextIDParser: A class to parse in an OSRS Wiki data dump and extract the
|
||||
ID numbers from a user specified OSRS Wiki data dump. Example usage:
|
||||
wiki_text_file_path = Path("extract_page_text_items.json")
|
||||
template_names = ["infobox item", "infobox pet"]
|
||||
wiki_data_ids = WikitextIDParser(wiki_text_file_path, template_names)
|
||||
Makes two accessible dictionaries:
|
||||
wiki_data_ids.item_id_to_version_number
|
||||
wiki_data_ids.item_id_to_wikitext
|
||||
|
||||
3) WikitextTemplateParser: A class to ease processing of wikitext templates. You
|
||||
can have an already extracted mwparserfromhell template (most likely an infobox),
|
||||
or extract the template on the fly. Example usage to load:
|
||||
infobox_parser = WikitextTemplateParser(wikitext)
|
||||
If you have an already extracted template, add it to the class:
|
||||
infobox_parser.template = <some-template-object>
|
||||
Otherwise you can try to extract an infobox template, will return a boolean of
|
||||
success/failure. Make sure to pass a name (infobox item, infobox bonuses,
|
||||
infobox pet).
|
||||
|
||||
Example usage:
|
||||
has_infobox = infobox_parser.extract_infobox("infobox item")
|
||||
Determine if the extracted infobox is versioned, returns boolean:
|
||||
is_versioned = infobox_parser.determine_infobox_versions()
|
||||
Extract the item IDs from an infobox, including version support. Returns a dictionary
|
||||
of item ID -> version number. For example: {12647: '1', 12654: '2'}
|
||||
versioned_ids = infobox_parser.extract_infobox_ids()
|
||||
|
||||
Copyright (c) 2021, PH01L
|
||||
|
||||
###############################################################################
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
###############################################################################
|
||||
"""
|
||||
import json
|
||||
from pathlib import Path
|
||||
from typing import Union, List, Dict
|
||||
|
||||
import mwparserfromhell
|
||||
|
||||
|
||||
def extract_wikitext_template(wikitext: str, template_type: str, multiple: bool = True) -> List:
|
||||
"""Parse raw wikitext and extract a specified template.
|
||||
|
||||
The OSRS Wiki stores structured information in a variety of different
|
||||
infobox templates structured using wikitext. This function parses the
|
||||
raw wikitext and extracts a wikitext template/s based on the template name
|
||||
provided as a paramater. Infobox example names include:
|
||||
|
||||
`infobox item`: An infobox for item properties.
|
||||
`infobox bonuses`: An infobox for equipable item bonuses.
|
||||
|
||||
A full list of all OSRS Wiki templates is available from:
|
||||
https://oldschool.runescape.wiki/w/RuneScape:Templates
|
||||
|
||||
:param wikitext: The raw wikitext.
|
||||
:param template_type: The type of infobox to extract.
|
||||
:param multiple: whether or not to extract multiple templates, default is True.
|
||||
:return: A list of mwpaserfromhell templates.
|
||||
"""
|
||||
templates = list()
|
||||
|
||||
try:
|
||||
wikicode = mwparserfromhell.parse(wikitext)
|
||||
except KeyError:
|
||||
# The wiki_name was not found in the available dumped wikitext pages
|
||||
# Return the empty list to indicate no templates were extracted
|
||||
return templates
|
||||
|
||||
# Loop through templates in wikicode from wiki page...
|
||||
filtered_templates = wikicode.filter_templates()
|
||||
for template in filtered_templates:
|
||||
template_name = template.name.strip()
|
||||
template_name = template_name.lower()
|
||||
if template_type in template_name:
|
||||
templates.append(template)
|
||||
if not multiple:
|
||||
# Only find the first instance, so return now
|
||||
return templates
|
||||
|
||||
# Return the list of extracted templates
|
||||
return templates
|
||||
|
||||
|
||||
class WikitextIDParser:
|
||||
def __init__(self, wikitext_file_path: Path, template_names: List):
|
||||
self.wikitext_file_path = wikitext_file_path # the raw wikitext dump
|
||||
self.template_names = template_names # The infobox name (e.g., infobox item, infobox monster)
|
||||
self.item_id_to_wikitext = dict() # Maps ID to wikitext (instead of name)
|
||||
self.item_id_to_version_number = dict() # Maps ID to template version
|
||||
self.item_id_to_wiki_name = dict() # Maps ID to original wiki page name
|
||||
|
||||
def process_osrswiki_data_dump(self):
|
||||
"""Process a raw OSRS Wiki and map IDs.
|
||||
|
||||
The OSRS Wiki categorizes wiki pages using the page name. Sometimes
|
||||
it is highly useful to extract the ID numbers on the OSRS Wiki page
|
||||
dump and map the ID to the infobox/template version number and the
|
||||
raw wikitext.
|
||||
"""
|
||||
# Read in the wiki text data dump
|
||||
with open(self.wikitext_file_path) as wikitext_file:
|
||||
wikitext_dump = json.load(wikitext_file)
|
||||
|
||||
# Loop all items in the OSRS Wiki data dump
|
||||
for name, wikitext in wikitext_dump.items():
|
||||
# Loop the list of proivided infobox template names
|
||||
for template_name in self.template_names:
|
||||
# Initialize the wikitext template parser
|
||||
infobox_parser = WikitextTemplateParser(wikitext)
|
||||
has_infobox = infobox_parser.extract_infobox(template_name)
|
||||
if has_infobox:
|
||||
infobox_parser.determine_infobox_versions()
|
||||
versioned_ids = infobox_parser.extract_infobox_ids()
|
||||
if not versioned_ids:
|
||||
continue
|
||||
for id, version_number in versioned_ids.items():
|
||||
self.item_id_to_version_number[id] = version_number
|
||||
self.item_id_to_wikitext[id] = wikitext
|
||||
self.item_id_to_wiki_name[id] = name
|
||||
|
||||
|
||||
class WikitextTemplateParser:
|
||||
def __init__(self, wikitext):
|
||||
self.wikitext = wikitext # the raw wikitext
|
||||
self.template = None # the extacted template
|
||||
self.is_versioned = False # is the template representing multiple entities
|
||||
|
||||
# Set specific wikitext infobox properties that can be versioned
|
||||
self.version_identifiers = {"id": 0,
|
||||
"name": 0,
|
||||
"itemid": 0}
|
||||
|
||||
def extract_infobox(self, template_type: str) -> bool:
|
||||
"""Parse raw wikitext and extract a specified infobox.
|
||||
|
||||
The OSRS Wiki stores structured information in a variety of different
|
||||
infobox templates structured using wikitext. This function parses the
|
||||
raw wikitext and extracts a wikitext template based on the template name
|
||||
provided as a paramater. Infobox example names include:
|
||||
|
||||
`infobox item`: An infobox for item properties.
|
||||
`infobox bonuses`: An infobox for equipable item bonuses.
|
||||
|
||||
A full list of all OSRS Wiki templates is available from:
|
||||
https://oldschool.runescape.wiki/w/RuneScape:Templates
|
||||
|
||||
NOTE: This function will only extract the first occurance on the requested
|
||||
template. If there are multiple templates, only the first is used. This is
|
||||
usually fine, as there is only one infobox with a unique name per page.
|
||||
|
||||
:param template_type: The type of infobox to extract.
|
||||
:return: A boolean representing sucessful processing.
|
||||
"""
|
||||
try:
|
||||
wikicode = mwparserfromhell.parse(self.wikitext)
|
||||
except KeyError:
|
||||
# The wiki_name was not found in the available dumped wikitext pages
|
||||
# Return false to indicate no wikitext was extracted
|
||||
# TODO: This should catch a different error
|
||||
return False
|
||||
|
||||
# Loop through templates in wikicode from wiki page
|
||||
# Then call Infobox Item processing method
|
||||
filtered_templates = wikicode.filter_templates()
|
||||
for template in filtered_templates:
|
||||
template_name = template.name.strip()
|
||||
template_name = template_name.lower()
|
||||
if template_type in template_name:
|
||||
self.template = template
|
||||
# Only find the first instance, so break
|
||||
break
|
||||
|
||||
# If no template_primary was found, return false
|
||||
if not self.template:
|
||||
return False
|
||||
|
||||
# If we got this far, return true
|
||||
return True
|
||||
|
||||
def determine_infobox_versions(self) -> bool:
|
||||
"""Determine if the infobox template is versioned.
|
||||
|
||||
Many OSRS Wiki infobox templates are versioned. This means that the infobox
|
||||
may represent multiple entities. For example, an `infobox item` may represent
|
||||
multiple items in different forms. This helper method will parse an infobox
|
||||
template and determine if multiple entites are discovered.
|
||||
|
||||
:return: A boolean representing sucessful processing.
|
||||
"""
|
||||
# Loop through the different version identifiers
|
||||
for version_identifier in self.version_identifiers:
|
||||
try:
|
||||
self.template.get(version_identifier + "1").value
|
||||
self.is_versioned = True
|
||||
break
|
||||
except ValueError:
|
||||
try:
|
||||
self.template.get(version_identifier + "2").value
|
||||
self.is_versioned = True
|
||||
break
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
# If the infobox is not versioned, return False
|
||||
if not self.is_versioned:
|
||||
self.version_identifiers["id"] = 1
|
||||
return False
|
||||
|
||||
# The infobox is versioned... continue processing
|
||||
# Try to determine the version counts for each version identifier
|
||||
for version_identifier in self.version_identifiers:
|
||||
i = 1
|
||||
while i <= 50:
|
||||
try:
|
||||
self.template.get(version_identifier + str(i)).value
|
||||
self.version_identifiers[version_identifier] += 1
|
||||
except ValueError:
|
||||
pass
|
||||
i += 1
|
||||
|
||||
return True
|
||||
|
||||
def extract_infobox_value(self, key: str) -> str:
|
||||
"""Helper method to extract a value from a template using a specified key.
|
||||
|
||||
This helper method is a simple solution to repeatedly try to fetch a specific
|
||||
entry from a wiki text template (a mwparserfromhell template object).
|
||||
|
||||
:param key: The key to query in the template.
|
||||
:return: The extracted template value based on supplied key.
|
||||
"""
|
||||
value = None
|
||||
try:
|
||||
value = self.template.get(key).value
|
||||
value = value.strip()
|
||||
return value
|
||||
except ValueError:
|
||||
return value
|
||||
|
||||
def extract_infobox_id(self, versioned_identifier: str) -> str:
|
||||
"""Helper method to extract an ID from a template using harcoded ID keys.
|
||||
|
||||
This helper method is a solution to query an infobox template for
|
||||
a unique ID number. The keys used are:
|
||||
`id`: Query template using only the string `id`.
|
||||
`id + version`: Query template using the string `id` including the `version` number.
|
||||
`itemid`: Query template using only the string `itemid`.
|
||||
`itemid + version`: Query template using the string `itemid` including the `version` number.
|
||||
|
||||
:param versioned_identifier: The number, as a string, to represent a versioned infobox.
|
||||
:return: The extracted template ID value (can be a comma-seperated string).
|
||||
"""
|
||||
value = None
|
||||
try:
|
||||
value = self.template.get(versioned_identifier).value
|
||||
value = value.strip()
|
||||
return value
|
||||
except ValueError:
|
||||
pass
|
||||
|
||||
def split_infobox_id_string(self, id_string: str) -> List:
|
||||
"""Helper method to split a comma-separated string of item IDs.
|
||||
|
||||
Some item ID property values are comma-seperated. This helper method
|
||||
splits the string and returns a list of IDs. If there is only one
|
||||
item ID, the method creates and returns the single value in a list.
|
||||
For example:
|
||||
2345,3456 outputs [2345, 3456]
|
||||
34 outputs [34]
|
||||
|
||||
:param id_string: A string of potentially comma-sererated item IDs
|
||||
:return: List of item IDs
|
||||
"""
|
||||
id_list = list()
|
||||
if "," in id_string:
|
||||
id_list = id_string.split(",")
|
||||
else:
|
||||
id_list.append(id_string)
|
||||
return id_list
|
||||
|
||||
def extract_infobox_ids(self) -> Dict:
|
||||
"""Extracts the item ID from a versione, or un-versioned Infobox.
|
||||
|
||||
This method extracts item IDs from a versined, or un-versioned, infobox
|
||||
template from the OSRS Wiki data. The data returned is a dictionary mapping:
|
||||
item_id -> version_number
|
||||
|
||||
Versioned example: the Kalphite princess pet item has two versions, crawling
|
||||
or airbourne. This method parses an already extracted `infobox pet` template
|
||||
an extracts the IDs associated with each item, including the infobox version
|
||||
number:
|
||||
id: 12647 is the crawling version, that uses version 1 in the infobox
|
||||
id: 12654 is the airbourne version, that uses version 2 in the infobox
|
||||
Returned data: {12647: '1', 12654: '2'}
|
||||
|
||||
Un-versioned example: Pet k'ril tsutsaroth has only one version.
|
||||
id: 12652
|
||||
Returned data: {12652: ""}
|
||||
The empty string indicates that no addition to the `id` property is needed
|
||||
to extract the data correctly, as the infobox is not versioned.
|
||||
|
||||
:return: A dictionary mapping item ID to version number.
|
||||
"""
|
||||
item_id_to_version_number = dict()
|
||||
|
||||
# First, try extract the non versioned identifier
|
||||
# Example: |id = 10591, followed by |id2 = 10592
|
||||
for identifier, count in self.version_identifiers.items():
|
||||
# Skip identifiers with no count
|
||||
if count == 0:
|
||||
continue
|
||||
id = self.extract_infobox_id(identifier) # Pass empty string, not versioned
|
||||
if id:
|
||||
ids = self.split_infobox_id_string(id)
|
||||
for id in ids:
|
||||
id = self.try_int_cast(id)
|
||||
if id is not None:
|
||||
item_id_to_version_number[id] = ""
|
||||
|
||||
if not self.is_versioned:
|
||||
return item_id_to_version_number
|
||||
|
||||
# Second, try extract the versioned identifier
|
||||
for identifier, count in self.version_identifiers.items():
|
||||
# Skip identifiers with no count
|
||||
if count == 0:
|
||||
continue
|
||||
|
||||
for i in range(1, count + 2):
|
||||
id = self.extract_infobox_id(identifier + str(i)) # Pass versioned string
|
||||
if id:
|
||||
ids = self.split_infobox_id_string(id)
|
||||
for id in ids:
|
||||
id = self.try_int_cast(id)
|
||||
if id is not None:
|
||||
item_id_to_version_number[id] = i
|
||||
|
||||
return item_id_to_version_number
|
||||
|
||||
def try_int_cast(self, value: str) -> Union[int, None]:
|
||||
"""Helper method to try int cast a string.
|
||||
|
||||
:param value: A value to try int cast.
|
||||
:return: Either an integer or None
|
||||
"""
|
||||
try:
|
||||
return int(value)
|
||||
except ValueError:
|
||||
return None
|
||||
3
setup.cfg
Normal file
3
setup.cfg
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
[flake8]
|
||||
max-line-length = 160
|
||||
exclude = venv
|
||||
46
statics/items-duplicates.json
Normal file
46
statics/items-duplicates.json
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
{
|
||||
"4561": {
|
||||
"name": "Purple sweets (2005 Hallowe'en event)",
|
||||
"duplicate": true
|
||||
},
|
||||
"2513": {
|
||||
"name": "Dragon chainbody",
|
||||
"duplicate": true
|
||||
},
|
||||
"21284": {
|
||||
"name": "Infernal max cape",
|
||||
"duplicate": true
|
||||
},
|
||||
"4150": {
|
||||
"name": "Broad arrows",
|
||||
"duplicate": true
|
||||
},
|
||||
"11068": {
|
||||
"name": "Gold bracelet",
|
||||
"duplicate": true
|
||||
},
|
||||
"11071": {
|
||||
"name": "Sapphire bracelet",
|
||||
"duplicate": true
|
||||
},
|
||||
"19492": {
|
||||
"name": "Zenyte bracelet",
|
||||
"duplicate": true
|
||||
},
|
||||
"9976": {
|
||||
"name": "Chinchompa",
|
||||
"duplicate": true
|
||||
},
|
||||
"9977": {
|
||||
"name": "Red chinchompa",
|
||||
"duplicate": true
|
||||
},
|
||||
"20782": {
|
||||
"name": "Bandos godsword (Misthalin Mystery)",
|
||||
"duplicate": true
|
||||
},
|
||||
"21913": {
|
||||
"name": "Mythical cape",
|
||||
"duplicate": true
|
||||
}
|
||||
}
|
||||
BIN
statics/items-icons/0.png
Normal file
BIN
statics/items-icons/0.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 630 B |
BIN
statics/items-icons/1.png
Normal file
BIN
statics/items-icons/1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 676 B |
BIN
statics/items-icons/10.png
Normal file
BIN
statics/items-icons/10.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 558 B |
BIN
statics/items-icons/100.png
Normal file
BIN
statics/items-icons/100.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 953 B |
BIN
statics/items-icons/10000.png
Normal file
BIN
statics/items-icons/10000.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 653 B |
BIN
statics/items-icons/10001.png
Normal file
BIN
statics/items-icons/10001.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 867 B |
BIN
statics/items-icons/10002.png
Normal file
BIN
statics/items-icons/10002.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 722 B |
BIN
statics/items-icons/10003.png
Normal file
BIN
statics/items-icons/10003.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 949 B |
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue