Added table and general functions for stats system #21
46 changed files with 3050 additions and 975 deletions
25
.gitignore
vendored
25
.gitignore
vendored
|
@ -1,3 +1,19 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu, VD15 and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
# Byte-compiled / optimized / DLL files
|
# Byte-compiled / optimized / DLL files
|
||||||
__pycache__/
|
__pycache__/
|
||||||
*.py[cod]
|
*.py[cod]
|
||||||
|
@ -147,6 +163,7 @@ venv.bak/
|
||||||
/site
|
/site
|
||||||
|
|
||||||
# mypy
|
# mypy
|
||||||
|
.mypy.ini
|
||||||
.mypy_cache/
|
.mypy_cache/
|
||||||
.dmypy.json
|
.dmypy.json
|
||||||
dmypy.json
|
dmypy.json
|
||||||
|
@ -181,5 +198,9 @@ cython_debug/
|
||||||
.cursorindexingignore
|
.cursorindexingignore
|
||||||
|
|
||||||
# Custom stuff
|
# Custom stuff
|
||||||
gacha_game.db
|
gacha_game*.db
|
||||||
config.ini
|
gacha_game*.db.*
|
||||||
|
config*.ini
|
||||||
|
run.sh
|
||||||
|
|
||||||
|
.idea
|
||||||
|
|
1
.tool-versions
Normal file
1
.tool-versions
Normal file
|
@ -0,0 +1 @@
|
||||||
|
nodejs 23.4.0
|
526
LICENSE
526
LICENSE
|
@ -1,23 +1,24 @@
|
||||||
GNU GENERAL PUBLIC LICENSE
|
# GNU AFFERO GENERAL PUBLIC LICENSE
|
||||||
Version 3, 29 June 2007
|
|
||||||
|
|
||||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
Version 3, 19 November 2007
|
||||||
Everyone is permitted to copy and distribute verbatim copies
|
|
||||||
of this license document, but changing it is not allowed.
|
|
||||||
|
|
||||||
Preamble
|
Copyright (C) 2007 Free Software Foundation, Inc.
|
||||||
|
<https://fsf.org/>
|
||||||
|
|
||||||
The GNU General Public License is a free, copyleft license for
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
software and other kinds of works.
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
## Preamble
|
||||||
|
|
||||||
|
The GNU Affero General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works, specifically designed to ensure
|
||||||
|
cooperation with the community in the case of network server software.
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
The licenses for most software and other practical works are designed
|
||||||
to take away your freedom to share and change the works. By contrast,
|
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
|
our General Public Licenses are intended to guarantee your freedom to
|
||||||
share and change all versions of a program--to make sure it remains free
|
share and change all versions of a program--to make sure it remains
|
||||||
software for all its users. We, the Free Software Foundation, use the
|
free software for all its users.
|
||||||
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
|
When we speak of free software, we are referring to freedom, not
|
||||||
price. Our General Public Licenses are designed to make sure that you
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
@ -26,65 +27,56 @@ 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
|
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.
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
To protect your rights, we need to prevent others from denying you
|
Developers that use our General Public Licenses protect your rights
|
||||||
these rights or asking you to surrender the rights. Therefore, you have
|
with two steps: (1) assert copyright on the software, and (2) offer
|
||||||
certain responsibilities if you distribute copies of the software, or if
|
you this License which gives you legal permission to copy, distribute
|
||||||
you modify it: responsibilities to respect the freedom of others.
|
and/or modify the software.
|
||||||
|
|
||||||
For example, if you distribute copies of such a program, whether
|
A secondary benefit of defending all users' freedom is that
|
||||||
gratis or for a fee, you must pass on to the recipients the same
|
improvements made in alternate versions of the program, if they
|
||||||
freedoms that you received. You must make sure that they, too, receive
|
receive widespread use, become available for other developers to
|
||||||
or can get the source code. And you must show them these terms so they
|
incorporate. Many developers of free software are heartened and
|
||||||
know their rights.
|
encouraged by the resulting cooperation. However, in the case of
|
||||||
|
software used on network servers, this result may fail to come about.
|
||||||
|
The GNU General Public License permits making a modified version and
|
||||||
|
letting the public access it on a server without ever releasing its
|
||||||
|
source code to the public.
|
||||||
|
|
||||||
Developers that use the GNU GPL protect your rights with two steps:
|
The GNU Affero General Public License is designed specifically to
|
||||||
(1) assert copyright on the software, and (2) offer you this License
|
ensure that, in such cases, the modified source code becomes available
|
||||||
giving you legal permission to copy, distribute and/or modify it.
|
to the community. It requires the operator of a network server to
|
||||||
|
provide the source code of the modified version running there to the
|
||||||
|
users of that server. Therefore, public use of a modified version, on
|
||||||
|
a publicly accessible server, gives the public access to the source
|
||||||
|
code of the modified version.
|
||||||
|
|
||||||
For the developers' and authors' protection, the GPL clearly explains
|
An older license, called the Affero General Public License and
|
||||||
that there is no warranty for this free software. For both users' and
|
published by Affero, was designed to accomplish similar goals. This is
|
||||||
authors' sake, the GPL requires that modified versions be marked as
|
a different license, not a version of the Affero GPL, but Affero has
|
||||||
changed, so that their problems will not be attributed erroneously to
|
released a new version of the Affero GPL which permits relicensing
|
||||||
authors of previous versions.
|
under this license.
|
||||||
|
|
||||||
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
|
The precise terms and conditions for copying, distribution and
|
||||||
modification follow.
|
modification follow.
|
||||||
|
|
||||||
TERMS AND CONDITIONS
|
## TERMS AND CONDITIONS
|
||||||
|
|
||||||
0. Definitions.
|
### 0. Definitions.
|
||||||
|
|
||||||
"This License" refers to version 3 of the GNU General Public License.
|
"This License" refers to version 3 of the GNU Affero General Public
|
||||||
|
License.
|
||||||
|
|
||||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
"Copyright" also means copyright-like laws that apply to other kinds
|
||||||
works, such as semiconductor masks.
|
of works, such as semiconductor masks.
|
||||||
|
|
||||||
"The Program" refers to any copyrightable work licensed under this
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
License. Each licensee is addressed as "you". "Licensees" and
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
"recipients" may be individuals or organizations.
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
To "modify" a work means to copy from or adapt all or part of the work
|
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
|
in a fashion requiring copyright permission, other than the making of
|
||||||
exact copy. The resulting work is called a "modified version" of the
|
an exact copy. The resulting work is called a "modified version" of
|
||||||
earlier work or a work "based on" the earlier work.
|
the earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
A "covered work" means either the unmodified Program or a work based
|
A "covered work" means either the unmodified Program or a work based
|
||||||
on the Program.
|
on the Program.
|
||||||
|
@ -97,11 +89,12 @@ distribution (with or without modification), making available to the
|
||||||
public, and in some countries other activities as well.
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
To "convey" a work means any kind of propagation that enables other
|
To "convey" a work means any kind of propagation that enables other
|
||||||
parties to make or receive copies. Mere interaction with a user through
|
parties to make or receive copies. Mere interaction with a user
|
||||||
a computer network, with no transfer of a copy, is not conveying.
|
through a computer network, with no transfer of a copy, is not
|
||||||
|
conveying.
|
||||||
|
|
||||||
An interactive user interface displays "Appropriate Legal Notices"
|
An interactive user interface displays "Appropriate Legal Notices" to
|
||||||
to the extent that it includes a convenient and prominently visible
|
the extent that it includes a convenient and prominently visible
|
||||||
feature that (1) displays an appropriate copyright notice, and (2)
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
tells the user that there is no warranty for the work (except to the
|
tells the user that there is no warranty for the work (except to the
|
||||||
extent that warranties are provided), that licensees may convey the
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
@ -109,11 +102,11 @@ 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
|
the interface presents a list of user commands or options, such as a
|
||||||
menu, a prominent item in the list meets this criterion.
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
1. Source Code.
|
### 1. Source Code.
|
||||||
|
|
||||||
The "source code" for a work means the preferred form of the work
|
The "source code" for a work means the preferred form of the work for
|
||||||
for making modifications to it. "Object code" means any non-source
|
making modifications to it. "Object code" means any non-source form of
|
||||||
form of a work.
|
a work.
|
||||||
|
|
||||||
A "Standard Interface" means an interface that either is an official
|
A "Standard Interface" means an interface that either is an official
|
||||||
standard defined by a recognized standards body, or, in the case of
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
@ -144,14 +137,13 @@ linked subprograms that the work is specifically designed to require,
|
||||||
such as by intimate data communication or control flow between those
|
such as by intimate data communication or control flow between those
|
||||||
subprograms and other parts of the work.
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
The Corresponding Source need not include anything that users
|
The Corresponding Source need not include anything that users can
|
||||||
can regenerate automatically from other parts of the Corresponding
|
regenerate automatically from other parts of the Corresponding Source.
|
||||||
Source.
|
|
||||||
|
|
||||||
The Corresponding Source for a work in source code form is that
|
The Corresponding Source for a work in source code form is that same
|
||||||
same work.
|
work.
|
||||||
|
|
||||||
2. Basic Permissions.
|
### 2. Basic Permissions.
|
||||||
|
|
||||||
All rights granted under this License are granted for the term of
|
All rights granted under this License are granted for the term of
|
||||||
copyright on the Program, and are irrevocable provided the stated
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
@ -161,22 +153,22 @@ covered work is covered by this License only if the output, given its
|
||||||
content, constitutes a covered work. This License acknowledges your
|
content, constitutes a covered work. This License acknowledges your
|
||||||
rights of fair use or other equivalent, as provided by copyright law.
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
You may make, run and propagate covered works that you do not
|
You may make, run and propagate covered works that you do not convey,
|
||||||
convey, without conditions so long as your license otherwise remains
|
without conditions so long as your license otherwise remains in force.
|
||||||
in force. You may convey covered works to others for the sole purpose
|
You may convey covered works to others for the sole purpose of having
|
||||||
of having them make modifications exclusively for you, or provide you
|
them make modifications exclusively for you, or provide you with
|
||||||
with facilities for running those works, provided that you comply with
|
facilities for running those works, provided that you comply with the
|
||||||
the terms of this License in conveying all material for which you do
|
terms of this License in conveying all material for which you do not
|
||||||
not control copyright. Those thus making or running the covered works
|
control copyright. Those thus making or running the covered works for
|
||||||
for you must do so exclusively on your behalf, under your direction
|
you must do so exclusively on your behalf, under your direction and
|
||||||
and control, on terms that prohibit them from making any copies of
|
control, on terms that prohibit them from making any copies of your
|
||||||
your copyrighted material outside their relationship with you.
|
copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
Conveying under any other circumstances is permitted solely under
|
Conveying under any other circumstances is permitted solely under the
|
||||||
the conditions stated below. Sublicensing is not allowed; section 10
|
conditions stated below. Sublicensing is not allowed; section 10 makes
|
||||||
makes it unnecessary.
|
it unnecessary.
|
||||||
|
|
||||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
No covered work shall be deemed part of an effective technological
|
No covered work shall be deemed part of an effective technological
|
||||||
measure under any applicable law fulfilling obligations under article
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
@ -185,14 +177,14 @@ similar laws prohibiting or restricting circumvention of such
|
||||||
measures.
|
measures.
|
||||||
|
|
||||||
When you convey a covered work, you waive any legal power to forbid
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
circumvention of technological measures to the extent such circumvention
|
circumvention of technological measures to the extent such
|
||||||
is effected by exercising rights under this License with respect to
|
circumvention is effected by exercising rights under this License with
|
||||||
the covered work, and you disclaim any intention to limit operation or
|
respect to the covered work, and you disclaim any intention to limit
|
||||||
modification of the work as a means of enforcing, against the work's
|
operation or modification of the work as a means of enforcing, against
|
||||||
users, your or third parties' legal rights to forbid circumvention of
|
the work's users, your or third parties' legal rights to forbid
|
||||||
technological measures.
|
circumvention of technological measures.
|
||||||
|
|
||||||
4. Conveying Verbatim Copies.
|
### 4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
You may convey verbatim copies of the Program's source code as you
|
You may convey verbatim copies of the Program's source code as you
|
||||||
receive it, in any medium, provided that you conspicuously and
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
@ -205,29 +197,27 @@ recipients a copy of this License along with the Program.
|
||||||
You may charge any price or no price for each copy that you convey,
|
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.
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
5. Conveying Modified Source Versions.
|
### 5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
You may convey a work based on the Program, or the modifications to
|
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
|
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:
|
terms of section 4, provided that you also meet all of these
|
||||||
|
conditions:
|
||||||
|
|
||||||
a) The work must carry prominent notices stating that you modified
|
- a) The work must carry prominent notices stating that you modified
|
||||||
it, and giving a relevant date.
|
it, and giving a relevant date.
|
||||||
|
- b) The work must carry prominent notices stating that it is
|
||||||
b) The work must carry prominent notices stating that it is
|
released under this License and any conditions added under
|
||||||
released under this License and any conditions added under section
|
section 7. This requirement modifies the requirement in section 4
|
||||||
7. This requirement modifies the requirement in section 4 to
|
to "keep intact all notices".
|
||||||
"keep intact all notices".
|
- c) You must license the entire work, as a whole, under this
|
||||||
|
|
||||||
c) You must license the entire work, as a whole, under this
|
|
||||||
License to anyone who comes into possession of a copy. This
|
License to anyone who comes into possession of a copy. This
|
||||||
License will therefore apply, along with any applicable section 7
|
License will therefore apply, along with any applicable section 7
|
||||||
additional terms, to the whole of the work, and all its parts,
|
additional terms, to the whole of the work, and all its parts,
|
||||||
regardless of how they are packaged. This License gives no
|
regardless of how they are packaged. This License gives no
|
||||||
permission to license the work in any other way, but it does not
|
permission to license the work in any other way, but it does not
|
||||||
invalidate such permission if you have separately received it.
|
invalidate such permission if you have separately received it.
|
||||||
|
- d) If the work has interactive user interfaces, each must display
|
||||||
d) If the work has interactive user interfaces, each must display
|
|
||||||
Appropriate Legal Notices; however, if the Program has interactive
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
interfaces that do not display Appropriate Legal Notices, your
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
work need not make them do so.
|
work need not make them do so.
|
||||||
|
@ -242,19 +232,18 @@ beyond what the individual works permit. Inclusion of a covered work
|
||||||
in an aggregate does not cause this License to apply to the other
|
in an aggregate does not cause this License to apply to the other
|
||||||
parts of the aggregate.
|
parts of the aggregate.
|
||||||
|
|
||||||
6. Conveying Non-Source Forms.
|
### 6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
You may convey a covered work in object code form under the terms
|
You may convey a covered work in object code form under the terms of
|
||||||
of sections 4 and 5, provided that you also convey the
|
sections 4 and 5, provided that you also convey the machine-readable
|
||||||
machine-readable Corresponding Source under the terms of this License,
|
Corresponding Source under the terms of this License, in one of these
|
||||||
in one of these ways:
|
ways:
|
||||||
|
|
||||||
a) Convey the object code in, or embodied in, a physical product
|
- a) Convey the object code in, or embodied in, a physical product
|
||||||
(including a physical distribution medium), accompanied by the
|
(including a physical distribution medium), accompanied by the
|
||||||
Corresponding Source fixed on a durable physical medium
|
Corresponding Source fixed on a durable physical medium
|
||||||
customarily used for software interchange.
|
customarily used for software interchange.
|
||||||
|
- b) Convey the object code in, or embodied in, a physical product
|
||||||
b) Convey the object code in, or embodied in, a physical product
|
|
||||||
(including a physical distribution medium), accompanied by a
|
(including a physical distribution medium), accompanied by a
|
||||||
written offer, valid for at least three years and valid for as
|
written offer, valid for at least three years and valid for as
|
||||||
long as you offer spare parts or customer support for that product
|
long as you offer spare parts or customer support for that product
|
||||||
|
@ -263,16 +252,14 @@ in one of these ways:
|
||||||
product that is covered by this License, on a durable physical
|
product that is covered by this License, on a durable physical
|
||||||
medium customarily used for software interchange, for a price no
|
medium customarily used for software interchange, for a price no
|
||||||
more than your reasonable cost of physically performing this
|
more than your reasonable cost of physically performing this
|
||||||
conveying of source, or (2) access to copy the
|
conveying of source, or (2) access to copy the Corresponding
|
||||||
Corresponding Source from a network server at no charge.
|
Source from a network server at no charge.
|
||||||
|
- c) Convey individual copies of the object code with a copy of the
|
||||||
c) Convey individual copies of the object code with a copy of the
|
|
||||||
written offer to provide the Corresponding Source. This
|
written offer to provide the Corresponding Source. This
|
||||||
alternative is allowed only occasionally and noncommercially, and
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
only if you received the object code with such an offer, in accord
|
only if you received the object code with such an offer, in accord
|
||||||
with subsection 6b.
|
with subsection 6b.
|
||||||
|
- d) Convey the object code by offering access from a designated
|
||||||
d) Convey the object code by offering access from a designated
|
|
||||||
place (gratis or for a charge), and offer equivalent access to the
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
Corresponding Source in the same way through the same place at no
|
Corresponding Source in the same way through the same place at no
|
||||||
further charge. You need not require recipients to copy the
|
further charge. You need not require recipients to copy the
|
||||||
|
@ -284,36 +271,36 @@ in one of these ways:
|
||||||
Corresponding Source. Regardless of what server hosts the
|
Corresponding Source. Regardless of what server hosts the
|
||||||
Corresponding Source, you remain obligated to ensure that it is
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
available for as long as needed to satisfy these requirements.
|
available for as long as needed to satisfy these requirements.
|
||||||
|
- e) Convey the object code using peer-to-peer transmission,
|
||||||
e) Convey the object code using peer-to-peer transmission, provided
|
provided you inform other peers where the object code and
|
||||||
you inform other peers where the object code and Corresponding
|
Corresponding Source of the work are being offered to the general
|
||||||
Source of the work are being offered to the general public at no
|
public at no charge under subsection 6d.
|
||||||
charge under subsection 6d.
|
|
||||||
|
|
||||||
A separable portion of the object code, whose source code is excluded
|
A separable portion of the object code, whose source code is excluded
|
||||||
from the Corresponding Source as a System Library, need not be
|
from the Corresponding Source as a System Library, need not be
|
||||||
included in conveying the object code work.
|
included in conveying the object code work.
|
||||||
|
|
||||||
A "User Product" is either (1) a "consumer product", which means any
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
tangible personal property which is normally used for personal, family,
|
tangible personal property which is normally used for personal,
|
||||||
or household purposes, or (2) anything designed or sold for incorporation
|
family, or household purposes, or (2) anything designed or sold for
|
||||||
into a dwelling. In determining whether a product is a consumer product,
|
incorporation into a dwelling. In determining whether a product is a
|
||||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
consumer product, doubtful cases shall be resolved in favor of
|
||||||
product received by a particular user, "normally used" refers to a
|
coverage. For a particular product received by a particular user,
|
||||||
typical or common use of that class of product, regardless of the status
|
"normally used" refers to a typical or common use of that class of
|
||||||
of the particular user or of the way in which the particular user
|
product, regardless of the status of the particular user or of the way
|
||||||
actually uses, or expects or is expected to use, the product. A product
|
in which the particular user actually uses, or expects or is expected
|
||||||
is a consumer product regardless of whether the product has substantial
|
to use, the product. A product is a consumer product regardless of
|
||||||
commercial, industrial or non-consumer uses, unless such uses represent
|
whether the product has substantial commercial, industrial or
|
||||||
the only significant mode of use of the product.
|
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,
|
"Installation Information" for a User Product means any methods,
|
||||||
procedures, authorization keys, or other information required to install
|
procedures, authorization keys, or other information required to
|
||||||
and execute modified versions of a covered work in that User Product from
|
install and execute modified versions of a covered work in that User
|
||||||
a modified version of its Corresponding Source. The information must
|
Product from a modified version of its Corresponding Source. The
|
||||||
suffice to ensure that the continued functioning of the modified object
|
information must suffice to ensure that the continued functioning of
|
||||||
code is in no case prevented or interfered with solely because
|
the modified object code is in no case prevented or interfered with
|
||||||
modification has been made.
|
solely because modification has been made.
|
||||||
|
|
||||||
If you convey an object code work under this section in, or with, or
|
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
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
@ -327,12 +314,13 @@ modified object code on the User Product (for example, the work has
|
||||||
been installed in ROM).
|
been installed in ROM).
|
||||||
|
|
||||||
The requirement to provide Installation Information does not include a
|
The requirement to provide Installation Information does not include a
|
||||||
requirement to continue to provide support service, warranty, or updates
|
requirement to continue to provide support service, warranty, or
|
||||||
for a work that has been modified or installed by the recipient, or for
|
updates for a work that has been modified or installed by the
|
||||||
the User Product in which it has been modified or installed. Access to a
|
recipient, or for the User Product in which it has been modified or
|
||||||
network may be denied when the modification itself materially and
|
installed. Access to a network may be denied when the modification
|
||||||
adversely affects the operation of the network or violates the rules and
|
itself materially and adversely affects the operation of the network
|
||||||
protocols for communication across the network.
|
or violates the rules and protocols for communication across the
|
||||||
|
network.
|
||||||
|
|
||||||
Corresponding Source conveyed, and Installation Information provided,
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
in accord with this section must be in a format that is publicly
|
in accord with this section must be in a format that is publicly
|
||||||
|
@ -340,7 +328,7 @@ documented (and with an implementation available to the public in
|
||||||
source code form), and must require no special password or key for
|
source code form), and must require no special password or key for
|
||||||
unpacking, reading or copying.
|
unpacking, reading or copying.
|
||||||
|
|
||||||
7. Additional Terms.
|
### 7. Additional Terms.
|
||||||
|
|
||||||
"Additional permissions" are terms that supplement the terms of this
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
License by making exceptions from one or more of its conditions.
|
License by making exceptions from one or more of its conditions.
|
||||||
|
@ -359,31 +347,26 @@ additional permissions on material, added by you to a covered work,
|
||||||
for which you have or can give appropriate copyright permission.
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, for material you
|
Notwithstanding any other provision of this License, for material you
|
||||||
add to a covered work, you may (if authorized by the copyright holders of
|
add to a covered work, you may (if authorized by the copyright holders
|
||||||
that material) supplement the terms of this License with terms:
|
of that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
a) Disclaiming warranty or limiting liability differently from the
|
- a) Disclaiming warranty or limiting liability differently from the
|
||||||
terms of sections 15 and 16 of this License; or
|
terms of sections 15 and 16 of this License; or
|
||||||
|
- b) Requiring preservation of specified reasonable legal notices or
|
||||||
b) Requiring preservation of specified reasonable legal notices or
|
|
||||||
author attributions in that material or in the Appropriate Legal
|
author attributions in that material or in the Appropriate Legal
|
||||||
Notices displayed by works containing it; or
|
Notices displayed by works containing it; or
|
||||||
|
- c) Prohibiting misrepresentation of the origin of that material,
|
||||||
c) Prohibiting misrepresentation of the origin of that material, or
|
or requiring that modified versions of such material be marked in
|
||||||
requiring that modified versions of such material be marked in
|
|
||||||
reasonable ways as different from the original version; or
|
reasonable ways as different from the original version; or
|
||||||
|
- d) Limiting the use for publicity purposes of names of licensors
|
||||||
d) Limiting the use for publicity purposes of names of licensors or
|
or authors of the material; or
|
||||||
authors of the material; or
|
- e) Declining to grant rights under trademark law for use of some
|
||||||
|
|
||||||
e) Declining to grant rights under trademark law for use of some
|
|
||||||
trade names, trademarks, or service marks; or
|
trade names, trademarks, or service marks; or
|
||||||
|
- f) Requiring indemnification of licensors and authors of that
|
||||||
f) Requiring indemnification of licensors and authors of that
|
material by anyone who conveys the material (or modified versions
|
||||||
material by anyone who conveys the material (or modified versions of
|
of it) with contractual assumptions of liability to the recipient,
|
||||||
it) with contractual assumptions of liability to the recipient, for
|
for any liability that these contractual assumptions directly
|
||||||
any liability that these contractual assumptions directly impose on
|
impose on those licensors and authors.
|
||||||
those licensors and authors.
|
|
||||||
|
|
||||||
All other non-permissive additional terms are considered "further
|
All other non-permissive additional terms are considered "further
|
||||||
restrictions" within the meaning of section 10. If the Program as you
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
@ -401,10 +384,10 @@ additional terms that apply to those files, or a notice indicating
|
||||||
where to find the applicable terms.
|
where to find the applicable terms.
|
||||||
|
|
||||||
Additional terms, permissive or non-permissive, may be stated in the
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
form of a separately written license, or stated as exceptions;
|
form of a separately written license, or stated as exceptions; the
|
||||||
the above requirements apply either way.
|
above requirements apply either way.
|
||||||
|
|
||||||
8. Termination.
|
### 8. Termination.
|
||||||
|
|
||||||
You may not propagate or modify a covered work except as expressly
|
You may not propagate or modify a covered work except as expressly
|
||||||
provided under this License. Any attempt otherwise to propagate or
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
@ -412,12 +395,12 @@ modify it is void, and will automatically terminate your rights under
|
||||||
this License (including any patent licenses granted under the third
|
this License (including any patent licenses granted under the third
|
||||||
paragraph of section 11).
|
paragraph of section 11).
|
||||||
|
|
||||||
However, if you cease all violation of this License, then your
|
However, if you cease all violation of this License, then your license
|
||||||
license from a particular copyright holder is reinstated (a)
|
from a particular copyright holder is reinstated (a) provisionally,
|
||||||
provisionally, unless and until the copyright holder explicitly and
|
unless and until the copyright holder explicitly and finally
|
||||||
finally terminates your license, and (b) permanently, if the copyright
|
terminates your license, and (b) permanently, if the copyright holder
|
||||||
holder fails to notify you of the violation by some reasonable means
|
fails to notify you of the violation by some reasonable means prior to
|
||||||
prior to 60 days after the cessation.
|
60 days after the cessation.
|
||||||
|
|
||||||
Moreover, your license from a particular copyright holder is
|
Moreover, your license from a particular copyright holder is
|
||||||
reinstated permanently if the copyright holder notifies you of the
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
@ -432,10 +415,10 @@ this License. If your rights have been terminated and not permanently
|
||||||
reinstated, you do not qualify to receive new licenses for the same
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
material under section 10.
|
material under section 10.
|
||||||
|
|
||||||
9. Acceptance Not Required for Having Copies.
|
### 9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
You are not required to accept this License in order to receive or
|
You are not required to accept this License in order to receive or run
|
||||||
run a copy of the Program. Ancillary propagation of a covered work
|
a copy of the Program. Ancillary propagation of a covered work
|
||||||
occurring solely as a consequence of using peer-to-peer transmission
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
to receive a copy likewise does not require acceptance. However,
|
to receive a copy likewise does not require acceptance. However,
|
||||||
nothing other than this License grants you permission to propagate or
|
nothing other than this License grants you permission to propagate or
|
||||||
|
@ -443,7 +426,7 @@ modify any covered work. These actions infringe copyright if you do
|
||||||
not accept this License. Therefore, by modifying or propagating a
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
covered work, you indicate your acceptance of this License to do so.
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
10. Automatic Licensing of Downstream Recipients.
|
### 10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
Each time you convey a covered work, the recipient automatically
|
Each time you convey a covered work, the recipient automatically
|
||||||
receives a license from the original licensors, to run, modify and
|
receives a license from the original licensors, to run, modify and
|
||||||
|
@ -468,14 +451,14 @@ rights granted under this License, and you may not initiate litigation
|
||||||
any patent claim is infringed by making, using, selling, offering for
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
sale, or importing the Program or any portion of it.
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
11. Patents.
|
### 11. Patents.
|
||||||
|
|
||||||
A "contributor" is a copyright holder who authorizes use under this
|
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
|
License of the Program or a work on which the Program is based. The
|
||||||
work thus licensed is called the contributor's "contributor version".
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
A contributor's "essential patent claims" are all patent claims
|
A contributor's "essential patent claims" are all patent claims owned
|
||||||
owned or controlled by the contributor, whether already acquired or
|
or controlled by the contributor, whether already acquired or
|
||||||
hereafter acquired, that would be infringed by some manner, permitted
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
by this License, of making, using, or selling its contributor version,
|
by this License, of making, using, or selling its contributor version,
|
||||||
but do not include claims that would be infringed only as a
|
but do not include claims that would be infringed only as a
|
||||||
|
@ -518,66 +501,77 @@ or convey a specific copy of the covered work, then the patent license
|
||||||
you grant is automatically extended to all recipients of the covered
|
you grant is automatically extended to all recipients of the covered
|
||||||
work and works based on it.
|
work and works based on it.
|
||||||
|
|
||||||
A patent license is "discriminatory" if it does not include within
|
A patent license is "discriminatory" if it does not include within the
|
||||||
the scope of its coverage, prohibits the exercise of, or is
|
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||||
conditioned on the non-exercise of one or more of the rights that are
|
the non-exercise of one or more of the rights that are specifically
|
||||||
specifically granted under this License. You may not convey a covered
|
granted under this License. You may not convey a covered work if you
|
||||||
work if you are a party to an arrangement with a third party that is
|
are a party to an arrangement with a third party that is in the
|
||||||
in the business of distributing software, under which you make payment
|
business of distributing software, under which you make payment to the
|
||||||
to the third party based on the extent of your activity of conveying
|
third party based on the extent of your activity of conveying the
|
||||||
the work, and under which the third party grants, to any of the
|
work, and under which the third party grants, to any of the parties
|
||||||
parties who would receive the covered work from you, a discriminatory
|
who would receive the covered work from you, a discriminatory patent
|
||||||
patent license (a) in connection with copies of the covered work
|
license (a) in connection with copies of the covered work conveyed by
|
||||||
conveyed by you (or copies made from those copies), or (b) primarily
|
you (or copies made from those copies), or (b) primarily for and in
|
||||||
for and in connection with specific products or compilations that
|
connection with specific products or compilations that contain the
|
||||||
contain the covered work, unless you entered into that arrangement,
|
covered work, unless you entered into that arrangement, or that patent
|
||||||
or that patent license was granted, prior to 28 March 2007.
|
license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
Nothing in this License shall be construed as excluding or limiting
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
any implied license or other defenses to infringement that may
|
any implied license or other defenses to infringement that may
|
||||||
otherwise be available to you under applicable patent law.
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
12. No Surrender of Others' Freedom.
|
### 12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
If conditions are imposed on you (whether by court order, agreement or
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
otherwise) that contradict the conditions of this License, they do not
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
excuse you from the conditions of this License. If you cannot convey a
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
covered work so as to satisfy simultaneously your obligations under this
|
covered work so as to satisfy simultaneously your obligations under
|
||||||
License and any other pertinent obligations, then as a consequence you may
|
this License and any other pertinent obligations, then as a
|
||||||
not convey it at all. For example, if you agree to terms that obligate you
|
consequence you may not convey it at all. For example, if you agree to
|
||||||
to collect a royalty for further conveying from those to whom you convey
|
terms that obligate you to collect a royalty for further conveying
|
||||||
the Program, the only way you could satisfy both those terms and this
|
from those to whom you convey the Program, the only way you could
|
||||||
License would be to refrain entirely from conveying the Program.
|
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.
|
### 13. Remote Network Interaction; Use with the GNU General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, if you modify the
|
||||||
|
Program, your modified version must prominently offer all users
|
||||||
|
interacting with it remotely through a computer network (if your
|
||||||
|
version supports such interaction) an opportunity to receive the
|
||||||
|
Corresponding Source of your version by providing access to the
|
||||||
|
Corresponding Source from a network server at no charge, through some
|
||||||
|
standard or customary means of facilitating copying of software. This
|
||||||
|
Corresponding Source shall include the Corresponding Source for any
|
||||||
|
work covered by version 3 of the GNU General Public License that is
|
||||||
|
incorporated pursuant to the following paragraph.
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
Notwithstanding any other provision of this License, you have
|
||||||
permission to link or combine any covered work with a work licensed
|
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
|
under version 3 of the GNU General Public License into a single
|
||||||
combined work, and to convey the resulting work. The terms of this
|
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,
|
License will continue to apply to the part which is the covered work,
|
||||||
but the special requirements of the GNU Affero General Public License,
|
but the work with which it is combined will remain governed by version
|
||||||
section 13, concerning interaction through a network will apply to the
|
3 of the GNU General Public License.
|
||||||
combination as such.
|
|
||||||
|
|
||||||
14. Revised Versions of this License.
|
### 14. Revised Versions of this License.
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions of
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
the GNU General Public License from time to time. Such new versions will
|
of the GNU Affero General Public License from time to time. Such new
|
||||||
be similar in spirit to the present version, but may differ in detail to
|
versions will be similar in spirit to the present version, but may
|
||||||
address new problems or concerns.
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the
|
Each version is given a distinguishing version number. If the Program
|
||||||
Program specifies that a certain numbered version of the GNU General
|
specifies that a certain numbered version of the GNU Affero General
|
||||||
Public License "or any later version" applies to it, you have the
|
Public License "or any later version" applies to it, you have the
|
||||||
option of following the terms and conditions either of that numbered
|
option of following the terms and conditions either of that numbered
|
||||||
version or of any later version published by the Free Software
|
version or of any later version published by the Free Software
|
||||||
Foundation. If the Program does not specify a version number of the
|
Foundation. If the Program does not specify a version number of the
|
||||||
GNU General Public License, you may choose any version ever published
|
GNU Affero General Public License, you may choose any version ever
|
||||||
by the Free Software Foundation.
|
published by the Free Software Foundation.
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future
|
If the Program specifies that a proxy can decide which future versions
|
||||||
versions of the GNU General Public License can be used, that proxy's
|
of the GNU Affero General Public License can be used, that proxy's
|
||||||
public statement of acceptance of a version permanently authorizes you
|
public statement of acceptance of a version permanently authorizes you
|
||||||
to choose that version for the Program.
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
@ -586,30 +580,31 @@ permissions. However, no additional obligations are imposed on any
|
||||||
author or copyright holder as a result of your choosing to follow a
|
author or copyright holder as a result of your choosing to follow a
|
||||||
later version.
|
later version.
|
||||||
|
|
||||||
15. Disclaimer of Warranty.
|
### 15. Disclaimer of Warranty.
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
||||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||||
|
CORRECTION.
|
||||||
|
|
||||||
16. Limitation of Liability.
|
### 16. Limitation of Liability.
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
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
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||||
SUCH DAMAGES.
|
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||||
|
|
||||||
17. Interpretation of Sections 15 and 16.
|
### 17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
above cannot be given local legal effect according to their terms,
|
above cannot be given local legal effect according to their terms,
|
||||||
|
@ -620,55 +615,46 @@ copy of the Program in return for a fee.
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
## How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
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
|
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.
|
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 do so, attach the following notices to the program. It is safest to
|
||||||
to attach them to the start of each source file to most effectively
|
attach them to the start of each source file to most effectively state
|
||||||
state the exclusion of warranty; and each file should have at least
|
the exclusion of warranty; and each file should have at least the
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
"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.>
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
Copyright (C) <year> <name of author>
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
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
|
it under the terms of the GNU Affero General Public License as
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
published by the Free Software Foundation, either version 3 of the
|
||||||
(at your option) any later version.
|
License, or (at your option) any later version.
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
GNU General Public License for more details.
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU Affero General Public License
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
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.
|
Also add information on how to contact you by electronic and paper
|
||||||
|
mail.
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
If your software can interact with users remotely through a computer
|
||||||
notice like this when it starts in an interactive mode:
|
network, you should also make sure that it provides a way for users to
|
||||||
|
get its source. For example, if your program is a web application, its
|
||||||
|
interface could display a "Source" link that leads users to an archive
|
||||||
|
of the code. There are many ways you could offer source, and different
|
||||||
|
solutions will be better for different programs; see section 13 for
|
||||||
|
the specific requirements.
|
||||||
|
|
||||||
<program> Copyright (C) <year> <name of author>
|
You should also get your employer (if you work as a programmer) or
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||||
This is free software, and you are welcome to redistribute it
|
necessary. For more information on this, and how to apply and follow
|
||||||
under certain conditions; type `show c' for details.
|
the GNU AGPL, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
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>.
|
|
||||||
|
|
75
bot/add_card.py
Normal file
75
bot/add_card.py
Normal file
|
@ -0,0 +1,75 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu, Moon, VD15 and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
import requests
|
||||||
|
import config
|
||||||
|
from fediverse_factory import get_fediverse_service
|
||||||
|
import db_utils
|
||||||
|
|
||||||
|
def add_card(name: str, rarity: int, image_url: str) -> tuple[int, str]:
|
||||||
|
"""
|
||||||
|
Adds a card to the database, uploading the image from a public URL to the Fediverse instance.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
name (str): Card name.
|
||||||
|
rarity (int): Card rarity (e.g., 1-5).
|
||||||
|
image_url (str): Public URL of the image from the post.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
tuple[int, str]: Card ID and file_id.
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If inputs are invalid.
|
||||||
|
RuntimeError: If image download/upload or database operation fails.
|
||||||
|
"""
|
||||||
|
|
||||||
|
stripped_name = name.strip()
|
||||||
|
|
||||||
|
# Validate inputs
|
||||||
|
if not stripped_name:
|
||||||
|
raise ValueError('Card name cannot be empty.')
|
||||||
|
if rarity < 1:
|
||||||
|
raise ValueError('Rarity must be a positive integer.')
|
||||||
|
if rarity not in config.RARITY_TO_WEIGHT.keys():
|
||||||
|
raise ValueError(f'Invalid rarity: {rarity}')
|
||||||
|
if not image_url:
|
||||||
|
raise ValueError('Image URL must be provided.')
|
||||||
|
|
||||||
|
try:
|
||||||
|
# Download image
|
||||||
|
response = requests.get(image_url, stream=True, timeout=30)
|
||||||
|
if response.status_code != 200:
|
||||||
|
raise RuntimeError(f"Failed to download image from {image_url}")
|
||||||
|
|
||||||
|
# Upload to Fediverse instance
|
||||||
|
fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
|
||||||
|
try:
|
||||||
|
uploaded_file = fediverse_service.upload_file(response.raw)
|
||||||
|
file_id = uploaded_file.id
|
||||||
|
except RuntimeError as e:
|
||||||
|
raise RuntimeError(f"Failed to upload image: {e}") from e
|
||||||
|
|
||||||
|
# Insert into database using db_utils function
|
||||||
|
card_id = db_utils.insert_card(
|
||||||
|
stripped_name,
|
||||||
|
rarity,
|
||||||
|
file_id
|
||||||
|
)
|
||||||
|
|
||||||
|
return card_id, file_id
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
raise
|
|
@ -1,49 +0,0 @@
|
||||||
import requests
|
|
||||||
from misskey.exceptions import MisskeyAPIException
|
|
||||||
from client import client_connection
|
|
||||||
from db_utils import insert_character
|
|
||||||
|
|
||||||
def add_character(name: str, rarity: int, weight: float, image_url: str) -> tuple[int, str]:
|
|
||||||
"""
|
|
||||||
Adds a character to the database, uploading the image from a public URL to
|
|
||||||
the bot's Misskey Drive.
|
|
||||||
|
|
||||||
Args:
|
|
||||||
name (str): Character name.
|
|
||||||
rarity (int): Character rarity (e.g., 1-5).
|
|
||||||
weight (float): Pull weight (e.g., 0.02).
|
|
||||||
image_url (str): Public URL of the image from the post (e.g., from note['files'][i]['url']).
|
|
||||||
|
|
||||||
Returns:
|
|
||||||
tuple[int, str]: Character ID and bot's Drive file_id.
|
|
||||||
|
|
||||||
Raises:
|
|
||||||
ValueError: If inputs are invalid.
|
|
||||||
RuntimeError: If image download/upload or database operation fails.
|
|
||||||
"""
|
|
||||||
# Validate inputs
|
|
||||||
if not name or not name.strip():
|
|
||||||
raise ValueError("Character name cannot be empty.")
|
|
||||||
if not isinstance(rarity, int) or rarity < 1:
|
|
||||||
raise ValueError("Rarity must be a positive integer.")
|
|
||||||
if not isinstance(weight, (int, float)) or weight <= 0:
|
|
||||||
raise ValueError("Weight must be a positive number.")
|
|
||||||
if not image_url:
|
|
||||||
raise ValueError("Image URL must be provided.")
|
|
||||||
|
|
||||||
# Download image
|
|
||||||
response = requests.get(image_url, stream=True, timeout=30)
|
|
||||||
if response.status_code != 200:
|
|
||||||
raise RuntimeError(f"Failed to download image from {image_url}")
|
|
||||||
|
|
||||||
# Upload to bot's Drive
|
|
||||||
mk = client_connection()
|
|
||||||
try:
|
|
||||||
media = mk.drive_files_create(response.raw)
|
|
||||||
file_id = media["id"]
|
|
||||||
except MisskeyAPIException as e:
|
|
||||||
raise RuntimeError(f"Failed to upload image to bot's Drive: {e}") from e
|
|
||||||
|
|
||||||
# Insert into database
|
|
||||||
character_id = insert_character(name.strip(), rarity, float(weight), file_id)
|
|
||||||
return character_id, file_id
|
|
|
@ -1,18 +1,78 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu, VD15, Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
import time
|
import time
|
||||||
import misskey as misskey
|
import traceback
|
||||||
from client import client_connection
|
import config
|
||||||
import db_utils as db
|
from notification import process_fediverse_notification
|
||||||
|
from db_utils import get_config, set_config, connect, setup_administrators
|
||||||
|
from fediverse_factory import get_fediverse_service
|
||||||
|
|
||||||
from config import NOTIFICATION_POLL_INTERVAL
|
from config import USE_WHITELIST
|
||||||
from notification import process_notifications
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
def stream_notifications():
|
||||||
# Initialize the Misskey client
|
# Initialize database connection
|
||||||
client = client_connection()
|
connect()
|
||||||
# Connect to DB
|
|
||||||
db.connect()
|
# Setup default administrators
|
||||||
|
setup_administrators()
|
||||||
|
|
||||||
|
# Initialize the Fediverse service
|
||||||
|
fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
|
||||||
|
|
||||||
|
# Get the last seen notification ID from the database
|
||||||
|
last_seen_id = get_config("last_seen_notif_id")
|
||||||
|
|
||||||
|
# Show whitelist status
|
||||||
|
whitelist_status = "enabled" if USE_WHITELIST else "disabled"
|
||||||
|
print(f'Instance whitelisting: {whitelist_status}')
|
||||||
|
|
||||||
print('Listening for notifications...')
|
print('Listening for notifications...')
|
||||||
while True:
|
while True:
|
||||||
if not process_notifications(client):
|
try:
|
||||||
time.sleep(NOTIFICATION_POLL_INTERVAL)
|
# Get notifications from the fediverse service
|
||||||
|
notifications = fediverse_service.get_notifications(since_id=last_seen_id)
|
||||||
|
|
||||||
|
if notifications:
|
||||||
|
new_last_seen_id = last_seen_id
|
||||||
|
|
||||||
|
for notification in notifications:
|
||||||
|
notif_id = notification.id
|
||||||
|
|
||||||
|
# Skip old or same ID notifications
|
||||||
|
if last_seen_id is not None and notif_id <= last_seen_id:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Process the notification using the abstracted processor
|
||||||
|
process_fediverse_notification(notification, fediverse_service)
|
||||||
|
|
||||||
|
# Update only if this notif_id is greater
|
||||||
|
if new_last_seen_id is None or notif_id > new_last_seen_id:
|
||||||
|
new_last_seen_id = notif_id
|
||||||
|
|
||||||
|
# Save the latest seen ID
|
||||||
|
if new_last_seen_id and new_last_seen_id != last_seen_id:
|
||||||
|
set_config("last_seen_notif_id", new_last_seen_id)
|
||||||
|
last_seen_id = new_last_seen_id
|
||||||
|
|
||||||
|
time.sleep(5)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
print(f"An exception has occured: {e}\n{traceback.format_exc()}")
|
||||||
|
time.sleep(5)
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
stream_notifications()
|
||||||
|
|
|
@ -1,5 +0,0 @@
|
||||||
import misskey
|
|
||||||
import config
|
|
||||||
|
|
||||||
def client_connection():
|
|
||||||
return misskey.Misskey(address=config.INSTANCE, i=config.KEY)
|
|
131
bot/config.py
131
bot/config.py
|
@ -1,23 +1,140 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu, VD15, Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
'''Essentials for the bot to function'''
|
'''Essentials for the bot to function'''
|
||||||
import configparser
|
import configparser
|
||||||
|
import json
|
||||||
|
import re
|
||||||
|
from os import environ, path
|
||||||
|
|
||||||
|
|
||||||
|
class ConfigError(Exception):
|
||||||
|
'''Could not find config file'''
|
||||||
|
|
||||||
|
|
||||||
|
def get_config_file() -> str:
|
||||||
|
'''Gets the path to the config file in the current environment'''
|
||||||
|
env: str | None = environ.get('KEMOVERSE_ENV')
|
||||||
|
if not env:
|
||||||
|
raise ConfigError('Error: KEMOVERSE_ENV is unset')
|
||||||
|
|
||||||
|
# Validate environment name contains only alphanumeric, dash, and underscore
|
||||||
|
if not re.match(r'^[a-zA-Z0-9_-]+$', env):
|
||||||
|
raise ValueError(f'KEMOVERSE_ENV "{env}" contains invalid characters. Only alphanumeric, dash (-), and underscore (_) are allowed.')
|
||||||
|
|
||||||
|
config_path: str = f'config_{env}.ini'
|
||||||
|
|
||||||
|
if not path.isfile(config_path):
|
||||||
|
raise ConfigError(f'Could not find {config_path}')
|
||||||
|
return config_path
|
||||||
|
|
||||||
|
|
||||||
|
def normalize_user(user_string: str) -> str:
|
||||||
|
"""
|
||||||
|
Normalizes a user string to the format @user@domain.tld where domain is lowercase and user is case-sensitive
|
||||||
|
|
||||||
|
Args:
|
||||||
|
user_string: User string in various formats
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Normalized user string
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If the user string is invalid or domain is malformed
|
||||||
|
"""
|
||||||
|
if not user_string or not user_string.strip():
|
||||||
|
raise ValueError("User string cannot be empty")
|
||||||
|
|
||||||
|
user_string = user_string.strip()
|
||||||
|
|
||||||
|
# Add leading @ if missing
|
||||||
|
if not user_string.startswith('@'):
|
||||||
|
user_string = '@' + user_string
|
||||||
|
|
||||||
|
# Split into user and domain parts
|
||||||
|
parts = user_string[1:].split('@', 1) # Remove leading @ and split
|
||||||
|
if len(parts) != 2:
|
||||||
|
raise ValueError(f"Invalid user format: {user_string}. Expected @user@domain.tld")
|
||||||
|
|
||||||
|
username, domain = parts
|
||||||
|
|
||||||
|
if not username:
|
||||||
|
raise ValueError("Username cannot be empty")
|
||||||
|
|
||||||
|
if not domain:
|
||||||
|
raise ValueError("Domain cannot be empty")
|
||||||
|
|
||||||
|
# Validate domain format (basic check for valid domain structure)
|
||||||
|
domain_pattern = r'^[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$'
|
||||||
|
if not re.match(domain_pattern, domain):
|
||||||
|
raise ValueError(f"Invalid domain format: {domain}")
|
||||||
|
|
||||||
|
# Return normalized format: @user@domain.tld (domain lowercase, user case-sensitive)
|
||||||
|
return f"@{username}@{domain.lower()}"
|
||||||
|
|
||||||
|
|
||||||
|
def get_rarity_to_weight(
|
||||||
|
config_section: configparser.SectionProxy) -> dict[int, float]:
|
||||||
|
"""Parses Rarity_X keys from config and returns a {rarity: weight} dict."""
|
||||||
|
rarity_weights = {}
|
||||||
|
for key, value in config_section.items():
|
||||||
|
if key.startswith("rarity_"):
|
||||||
|
rarity = int(key.removeprefix("rarity_"))
|
||||||
|
rarity_weights[rarity] = float(value)
|
||||||
|
return rarity_weights
|
||||||
|
|
||||||
|
|
||||||
config = configparser.ConfigParser()
|
config = configparser.ConfigParser()
|
||||||
config.read('config.ini')
|
config.read(get_config_file())
|
||||||
|
|
||||||
# Username for the bot
|
# Username for the bot
|
||||||
USER = config['credentials']['User']
|
if 'User' not in config['credentials'] or not config['credentials']['User'].strip():
|
||||||
|
raise ConfigError("User must be specified in config.ini under [credentials]")
|
||||||
|
|
||||||
|
USER = normalize_user(config['credentials']['User'])
|
||||||
# API key for the bot
|
# API key for the bot
|
||||||
KEY = config['credentials']['Token']
|
KEY = config['credentials']['Token']
|
||||||
# Bot's Misskey instance URL
|
# Bot's Misskey/Pleroma instance URL
|
||||||
INSTANCE = config['credentials']['Instance']
|
INSTANCE = config['credentials']['Instance'].lower()
|
||||||
|
|
||||||
|
# Instance type validation
|
||||||
|
if 'InstanceType' not in config['application']:
|
||||||
|
raise ValueError("InstanceType must be specified in config.ini")
|
||||||
|
|
||||||
|
instance_type = config['application']['InstanceType'].lower()
|
||||||
|
if instance_type not in ('misskey', 'pleroma'):
|
||||||
|
raise ValueError("InstanceType must be either 'misskey' or 'pleroma'")
|
||||||
|
|
||||||
|
INSTANCE_TYPE = instance_type
|
||||||
|
|
||||||
|
# Web server port
|
||||||
|
WEB_PORT = config['application'].getint('WebPort', 5000)
|
||||||
|
BIND_ADDRESS = config['application'].get('BindAddress', '127.0.0.1')
|
||||||
|
|
||||||
# TODO: move this to db
|
|
||||||
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
|
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
|
||||||
# to use extra admin exclusive commands with the bot
|
# to use extra admin exclusive commands with the bot
|
||||||
ADMINS = config['application']['DefaultAdmins']
|
ADMINS = json.loads(config['application']['DefaultAdmins'])
|
||||||
# SQLite Database location
|
# SQLite Database location
|
||||||
DB_PATH = config['application']['DatabaseLocation']
|
DB_PATH = config['application'].get('DatabaseLocation', './gacha_game.db')
|
||||||
|
# Whether to enable the instance whitelist
|
||||||
|
USE_WHITELIST = config['application'].getboolean('UseWhitelist', True)
|
||||||
|
|
||||||
NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
|
NOTIFICATION_POLL_INTERVAL = int(config['notification']['PollInterval'])
|
||||||
NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
|
NOTIFICATION_BATCH_SIZE = int(config['notification']['BatchSize'])
|
||||||
|
|
||||||
GACHA_ROLL_INTERVAL = int(config['gacha']['RollInterval'])
|
GACHA_ROLL_INTERVAL = int(config['gacha']['RollInterval'])
|
||||||
|
|
||||||
|
RARITY_TO_WEIGHT = get_rarity_to_weight(config['gacha'])
|
||||||
|
|
37
bot/custom_types.py
Normal file
37
bot/custom_types.py
Normal file
|
@ -0,0 +1,37 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 VD15 and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
from typing import TypedDict, List, Dict, Any
|
||||||
|
|
||||||
|
BotResponse = TypedDict('BotResponse', {
|
||||||
|
'message': str,
|
||||||
|
'attachment_urls': List[str] | None
|
||||||
|
})
|
||||||
|
|
||||||
|
Card = TypedDict('Card', {
|
||||||
|
'id': int,
|
||||||
|
'name': str,
|
||||||
|
'rarity': int,
|
||||||
|
'weight': float,
|
||||||
|
'image_url': str
|
||||||
|
})
|
||||||
|
|
||||||
|
ParsedNotification = TypedDict('ParsedNotification', {
|
||||||
|
'author': str,
|
||||||
|
'command': str | None,
|
||||||
|
'arguments': List[str],
|
||||||
|
'note_obj': Dict[str, Any]
|
||||||
|
})
|
284
bot/db_utils.py
284
bot/db_utils.py
|
@ -1,11 +1,29 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu VD15, Moon, and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
from random import choices
|
from random import choices
|
||||||
import sqlite3
|
import sqlite3
|
||||||
import config
|
import config
|
||||||
|
from custom_types import Card
|
||||||
|
|
||||||
DB_PATH = config.DB_PATH
|
DB_PATH = config.DB_PATH
|
||||||
CONNECTION: sqlite3.Connection
|
CONNECTION: sqlite3.Connection
|
||||||
CURSOR: sqlite3.Cursor
|
CURSOR: sqlite3.Cursor
|
||||||
|
|
||||||
|
|
||||||
def connect() -> None:
|
def connect() -> None:
|
||||||
'''Creates a connection to the database'''
|
'''Creates a connection to the database'''
|
||||||
print('Connecting to the database...')
|
print('Connecting to the database...')
|
||||||
|
@ -15,114 +33,206 @@ def connect() -> None:
|
||||||
CONNECTION.row_factory = sqlite3.Row
|
CONNECTION.row_factory = sqlite3.Row
|
||||||
CURSOR = CONNECTION.cursor()
|
CURSOR = CONNECTION.cursor()
|
||||||
|
|
||||||
def get_random_character():
|
|
||||||
''' Gets a random character from the database'''
|
|
||||||
CURSOR.execute('SELECT * FROM characters')
|
|
||||||
characters = CURSOR.fetchall()
|
|
||||||
|
|
||||||
if not characters:
|
def setup_administrators() -> None:
|
||||||
return None, None, None, None
|
'''Creates administrator players for each handle in the config file'''
|
||||||
|
# Get default admins from config
|
||||||
weights = [c['weight'] for c in characters]
|
for username in config.ADMINS:
|
||||||
chosen = choices(characters, weights=weights, k=1)[0]
|
player_id = get_player(username)
|
||||||
|
if player_id == 0:
|
||||||
return chosen['id'], chosen['name'], chosen['file_id'], chosen['rarity']
|
# Create player if not exists
|
||||||
|
print(f'Creating administrator player: {username}')
|
||||||
|
|
||||||
# User functions
|
|
||||||
|
|
||||||
def get_or_create_user(username):
|
|
||||||
'''Retrieves an ID for a given user, if the user does not exist, it will be
|
|
||||||
created.'''
|
|
||||||
CURSOR.execute('SELECT id FROM users WHERE username = ?', (username,))
|
|
||||||
user = CURSOR.fetchone()
|
|
||||||
if user:
|
|
||||||
return user[0]
|
|
||||||
|
|
||||||
# New user starts with has_rolled = False
|
|
||||||
CURSOR.execute(
|
CURSOR.execute(
|
||||||
'INSERT INTO users (username, has_rolled) VALUES (?, ?)',
|
'INSERT INTO players (username, has_rolled, is_administrator) \
|
||||||
|
VALUES (?, ?, ?)',
|
||||||
|
(username, False, True)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# Update is_administrator if exists
|
||||||
|
print(f'Granting administrator to player: {username}')
|
||||||
|
CURSOR.execute(
|
||||||
|
'UPDATE players SET is_administrator = 1 WHERE id = ?',
|
||||||
|
(player_id,)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_random_card() -> Card | None:
|
||||||
|
''' Gets a random card from the database'''
|
||||||
|
CURSOR.execute('SELECT * FROM cards')
|
||||||
|
cards = CURSOR.fetchall()
|
||||||
|
|
||||||
|
if not cards:
|
||||||
|
return None
|
||||||
|
|
||||||
|
weights = [config.RARITY_TO_WEIGHT[c['rarity']] for c in cards]
|
||||||
|
chosen = choices(cards, weights=weights, k=1)[0]
|
||||||
|
|
||||||
|
return {
|
||||||
|
'id': chosen['id'],
|
||||||
|
'name': chosen['name'],
|
||||||
|
'rarity': chosen['rarity'],
|
||||||
|
'weight': config.RARITY_TO_WEIGHT[chosen['rarity']],
|
||||||
|
'image_url': chosen['file_id']
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def get_player(username: str) -> int:
|
||||||
|
'''Retrieve a player ID by username, or return None if not found.'''
|
||||||
|
CURSOR.execute(
|
||||||
|
'SELECT id FROM players WHERE username = ?',
|
||||||
|
(username,)
|
||||||
|
)
|
||||||
|
player = CURSOR.fetchone()
|
||||||
|
if player:
|
||||||
|
return int(player[0])
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
def insert_player(username: str) -> int:
|
||||||
|
'''Insert a new player with default has_rolled = False and return their
|
||||||
|
player ID.'''
|
||||||
|
CURSOR.execute(
|
||||||
|
'INSERT INTO players (username, has_rolled) VALUES (?, ?)',
|
||||||
(username, False)
|
(username, False)
|
||||||
)
|
)
|
||||||
user_id = CURSOR.lastrowid
|
return CURSOR.lastrowid if CURSOR.lastrowid else 0
|
||||||
return user_id
|
|
||||||
|
|
||||||
def insert_character(name: str, rarity: int, weight: float, file_id: str, stats: dict) -> int:
|
|
||||||
'''Inserts a character'''
|
def delete_player(username: str) -> bool:
|
||||||
|
'''Permanently deletes a player and all their pulls.'''
|
||||||
CURSOR.execute(
|
CURSOR.execute(
|
||||||
'INSERT INTO characters (name, rarity, weight, file_id) VALUES (?, ?, ?, ?)',
|
'SELECT id FROM players WHERE username = ?',
|
||||||
(name, rarity, weight, file_id)
|
(username,)
|
||||||
)
|
)
|
||||||
character_id = CURSOR.lastrowid
|
player = CURSOR.fetchone()
|
||||||
|
|
||||||
# Insert stats
|
if not player:
|
||||||
columns = ', '.join(stats.keys())
|
return False
|
||||||
placeholders = ', '.join(['?'] * len(stats))
|
|
||||||
updates = ', '.join([f"{col}=excluded.{col}" for col in stats.keys()])
|
|
||||||
values = list(stats.values())
|
|
||||||
|
|
||||||
sql = f'''
|
player_id = player[0]
|
||||||
INSERT INTO character_stats (character_id, {columns})
|
|
||||||
VALUES (?, {placeholders})
|
|
||||||
ON CONFLICT(character_id) DO UPDATE SET {updates}
|
|
||||||
'''
|
|
||||||
CURSOR.execute(sql, [character_id] + values)
|
|
||||||
|
|
||||||
return character_id if character_id else 0
|
# Delete pulls
|
||||||
|
CURSOR.execute(
|
||||||
|
'DELETE FROM pulls WHERE player_id = ?',
|
||||||
|
(player_id,)
|
||||||
|
)
|
||||||
|
|
||||||
def insert_pull(user_id, character_id):
|
# Delete player
|
||||||
|
CURSOR.execute(
|
||||||
|
'DELETE FROM players WHERE id = ?',
|
||||||
|
(player_id,)
|
||||||
|
)
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def ban_player(username: str) -> bool:
|
||||||
|
'''Adds a player to the ban list.'''
|
||||||
|
try:
|
||||||
|
CURSOR.execute(
|
||||||
|
'INSERT INTO banned_players (handle) VALUES (?)',
|
||||||
|
(username,)
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
except sqlite3.IntegrityError:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def unban_player(username: str) -> bool:
|
||||||
|
'''Removes a player from the ban list.'''
|
||||||
|
CURSOR.execute(
|
||||||
|
'DELETE FROM banned_players WHERE handle = ?',
|
||||||
|
(username,)
|
||||||
|
)
|
||||||
|
return CURSOR.rowcount > 0
|
||||||
|
|
||||||
|
|
||||||
|
def is_player_banned(username: str) -> bool:
|
||||||
|
CURSOR.execute(
|
||||||
|
'SELECT * FROM banned_players WHERE handle = ?',
|
||||||
|
(username,)
|
||||||
|
)
|
||||||
|
row = CURSOR.fetchone()
|
||||||
|
return row is not None
|
||||||
|
|
||||||
|
|
||||||
|
def is_player_administrator(username: str) -> bool:
|
||||||
|
CURSOR.execute(
|
||||||
|
'SELECT is_administrator FROM players WHERE username = ? LIMIT 1',
|
||||||
|
(username,)
|
||||||
|
)
|
||||||
|
row = CURSOR.fetchone()
|
||||||
|
return row[0] if row else False
|
||||||
|
|
||||||
|
|
||||||
|
def insert_card(
|
||||||
|
name: str, rarity: int, file_id: str) -> int:
|
||||||
|
'''Inserts a card'''
|
||||||
|
CURSOR.execute(
|
||||||
|
'INSERT INTO cards (name, rarity, file_id) VALUES (?, ?, ?)',
|
||||||
|
(name, rarity, file_id)
|
||||||
|
)
|
||||||
|
card_id = CURSOR.lastrowid
|
||||||
|
return card_id if card_id else 0
|
||||||
|
|
||||||
|
|
||||||
|
def insert_pull(player_id: int, card_id: int) -> None:
|
||||||
'''Creates a pull in the database'''
|
'''Creates a pull in the database'''
|
||||||
CURSOR.execute(
|
CURSOR.execute(
|
||||||
'INSERT INTO pulls (user_id, character_id) VALUES (?, ?)',
|
'INSERT INTO pulls (player_id, card_id) VALUES (?, ?)',
|
||||||
(user_id, character_id)
|
(player_id, card_id)
|
||||||
)
|
)
|
||||||
|
|
||||||
def get_last_rolled_at(user_id):
|
|
||||||
'''Gets the timestamp when the user last rolled'''
|
def get_last_rolled_at(player_id: int) -> int:
|
||||||
CURSOR.execute("SELECT timestamp FROM pulls WHERE user_id = ? ORDER BY timestamp DESC", \
|
'''Gets the timestamp when the player last rolled'''
|
||||||
(user_id,))
|
CURSOR.execute(
|
||||||
|
"SELECT timestamp FROM pulls WHERE player_id = ? ORDER BY timestamp \
|
||||||
|
DESC",
|
||||||
|
(player_id,))
|
||||||
row = CURSOR.fetchone()
|
row = CURSOR.fetchone()
|
||||||
return row[0] if row else None
|
return row[0] if row else 0
|
||||||
|
|
||||||
# Configuration
|
# Configuration
|
||||||
|
|
||||||
def get_config(key):
|
def add_to_whitelist(instance: str) -> bool:
|
||||||
|
'''Adds an instance to the whitelist, returns false if instance was already
|
||||||
|
present'''
|
||||||
|
try:
|
||||||
|
CURSOR.execute(
|
||||||
|
'INSERT INTO instance_whitelist (tld) VALUES (?)', (instance,)
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
except sqlite3.IntegrityError:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def remove_from_whitelist(instance: str) -> bool:
|
||||||
|
'''Removes an instance to the whitelist, returns false if instance was not
|
||||||
|
present'''
|
||||||
|
CURSOR.execute(
|
||||||
|
'DELETE FROM instance_whitelist WHERE tld = ?', (instance,))
|
||||||
|
return CURSOR.rowcount > 0
|
||||||
|
|
||||||
|
|
||||||
|
def is_whitelisted(instance: str) -> bool:
|
||||||
|
'''Checks whether an instance is in the whitelist'''
|
||||||
|
if instance == 'local':
|
||||||
|
return True
|
||||||
|
CURSOR.execute(
|
||||||
|
'SELECT * FROM instance_whitelist WHERE tld = ?', (instance,))
|
||||||
|
row = CURSOR.fetchone()
|
||||||
|
return row is not None
|
||||||
|
|
||||||
|
|
||||||
|
def get_config(key: str) -> str:
|
||||||
'''Reads the value for a specified config key from the db'''
|
'''Reads the value for a specified config key from the db'''
|
||||||
CURSOR.execute("SELECT value FROM config WHERE key = ?", (key,))
|
CURSOR.execute("SELECT value FROM config WHERE key = ?", (key,))
|
||||||
row = CURSOR.fetchone()
|
row = CURSOR.fetchone()
|
||||||
return row[0] if row else None
|
return row[0] if row else ''
|
||||||
|
|
||||||
def set_config(key, value):
|
|
||||||
|
def set_config(key: str, value: str) -> None:
|
||||||
'''Writes the value for a specified config key to the db'''
|
'''Writes the value for a specified config key to the db'''
|
||||||
cur.execute("INSERT OR REPLACE INTO config (key, value) VALUES (?, ?)", (key, value))
|
CURSOR.execute("INSERT OR REPLACE INTO config (key, value) VALUES (?, ?)",
|
||||||
|
(key, value))
|
||||||
|
|
||||||
# Character stat functions
|
|
||||||
|
|
||||||
def get_characters(character_ids):
|
|
||||||
'''
|
|
||||||
Retrieves stats for a list of character IDs.
|
|
||||||
Returns a dictionary of character_id -> {stat_name: value, ...}
|
|
||||||
'''
|
|
||||||
if not character_ids:
|
|
||||||
return {}
|
|
||||||
|
|
||||||
placeholders = ','.join('?' for _ in character_ids)
|
|
||||||
query = f'''
|
|
||||||
SELECT *
|
|
||||||
FROM character_stats
|
|
||||||
WHERE character_id IN ({placeholders})
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
CURSOR.execute(query, character_ids)
|
|
||||||
rows = cur.fetchall()
|
|
||||||
col_names = [desc[0] for desc in cur.description]
|
|
||||||
|
|
||||||
result = {}
|
|
||||||
for row in rows:
|
|
||||||
character_id = row[0]
|
|
||||||
stats = dict(zip(col_names[1:], row[1:])) # Skip character_id
|
|
||||||
result[character_id] = stats
|
|
||||||
|
|
||||||
return result
|
|
||||||
|
|
56
bot/fediverse_factory.py
Normal file
56
bot/fediverse_factory.py
Normal file
|
@ -0,0 +1,56 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
from fediverse_service import FediverseService
|
||||||
|
from misskey_service import MisskeyService
|
||||||
|
from pleroma_service import PleromaService
|
||||||
|
|
||||||
|
|
||||||
|
class FediverseServiceFactory:
|
||||||
|
"""Factory for creating FediverseService implementations"""
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def create_service(instance_type: str) -> FediverseService:
|
||||||
|
"""
|
||||||
|
Create a FediverseService implementation based on the instance type.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
instance_type: The type of instance ("misskey" or "pleroma")
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
FediverseService implementation (MisskeyService or PleromaService)
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
ValueError: If the instance type is not supported
|
||||||
|
"""
|
||||||
|
instance_type = instance_type.lower()
|
||||||
|
|
||||||
|
if instance_type == "misskey":
|
||||||
|
return MisskeyService()
|
||||||
|
elif instance_type == "pleroma":
|
||||||
|
return PleromaService()
|
||||||
|
else:
|
||||||
|
raise ValueError(f"Unsupported instance type: {instance_type}")
|
||||||
|
|
||||||
|
|
||||||
|
def get_fediverse_service(instance_type: str) -> FediverseService:
|
||||||
|
"""
|
||||||
|
Convenience function to get a FediverseService instance
|
||||||
|
|
||||||
|
Args:
|
||||||
|
instance_type: The instance type ("misskey" or "pleroma")
|
||||||
|
"""
|
||||||
|
return FediverseServiceFactory.create_service(instance_type)
|
90
bot/fediverse_service.py
Normal file
90
bot/fediverse_service.py
Normal file
|
@ -0,0 +1,90 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
from abc import ABC, abstractmethod
|
||||||
|
from typing import List, Optional, Union, BinaryIO
|
||||||
|
from fediverse_types import FediverseNotification, FediversePost, FediverseFile, Visibility
|
||||||
|
|
||||||
|
|
||||||
|
class FediverseService(ABC):
|
||||||
|
"""Abstract interface for Fediverse platform services (Misskey, Pleroma, etc.)"""
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
|
||||||
|
"""
|
||||||
|
Retrieve notifications from the Fediverse instance.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
since_id: Optional ID to get notifications newer than this ID
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of FediverseNotification objects
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def create_post(
|
||||||
|
self,
|
||||||
|
text: str,
|
||||||
|
reply_to_id: Optional[str] = None,
|
||||||
|
visibility: Visibility = Visibility.HOME,
|
||||||
|
file_ids: Optional[List[str]] = None,
|
||||||
|
visible_user_ids: Optional[List[str]] = None
|
||||||
|
) -> str:
|
||||||
|
"""
|
||||||
|
Create a new post on the Fediverse instance.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
text: The text content of the post
|
||||||
|
reply_to_id: Optional ID of post to reply to
|
||||||
|
visibility: Visibility level for the post
|
||||||
|
file_ids: Optional list of file IDs to attach
|
||||||
|
visible_user_ids: Optional list of user IDs who can see the post (for specified visibility)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
ID of the created post
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
|
||||||
|
"""
|
||||||
|
Retrieve a specific post by its ID.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
post_id: The ID of the post to retrieve
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
FediversePost object if found, None otherwise
|
||||||
|
"""
|
||||||
|
pass
|
||||||
|
|
||||||
|
@abstractmethod
|
||||||
|
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
|
||||||
|
"""
|
||||||
|
Upload a file to the Fediverse instance.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
file_data: File data as binary stream or bytes
|
||||||
|
filename: Optional filename for the uploaded file
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
FediverseFile object with ID, URL, and other metadata
|
||||||
|
|
||||||
|
Raises:
|
||||||
|
RuntimeError: If file upload fails
|
||||||
|
"""
|
||||||
|
pass
|
89
bot/fediverse_types.py
Normal file
89
bot/fediverse_types.py
Normal file
|
@ -0,0 +1,89 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from typing import Optional, List, Dict, Any
|
||||||
|
from enum import Enum
|
||||||
|
|
||||||
|
|
||||||
|
class NotificationType(Enum):
|
||||||
|
MENTION = "mention"
|
||||||
|
REPLY = "reply"
|
||||||
|
FOLLOW = "follow"
|
||||||
|
FAVOURITE = "favourite"
|
||||||
|
REBLOG = "reblog"
|
||||||
|
POLL = "poll"
|
||||||
|
OTHER = "other"
|
||||||
|
|
||||||
|
|
||||||
|
class Visibility(Enum):
|
||||||
|
PUBLIC = "public"
|
||||||
|
UNLISTED = "unlisted"
|
||||||
|
HOME = "home"
|
||||||
|
FOLLOWERS = "followers"
|
||||||
|
SPECIFIED = "specified"
|
||||||
|
DIRECT = "direct"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class FediverseUser:
|
||||||
|
"""Common user representation across Fediverse platforms"""
|
||||||
|
id: str
|
||||||
|
username: str
|
||||||
|
host: Optional[str] = None # None for local users
|
||||||
|
display_name: Optional[str] = None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def full_handle(self) -> str:
|
||||||
|
"""Returns the full fediverse handle (@user@domain or @user for local)"""
|
||||||
|
if self.host:
|
||||||
|
return f"@{self.username}@{self.host}"
|
||||||
|
return f"@{self.username}"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class FediverseFile:
|
||||||
|
"""Common file/attachment representation"""
|
||||||
|
id: str
|
||||||
|
url: str
|
||||||
|
type: Optional[str] = None
|
||||||
|
name: Optional[str] = None
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class FediversePost:
|
||||||
|
"""Common post representation across Fediverse platforms"""
|
||||||
|
id: str
|
||||||
|
text: Optional[str]
|
||||||
|
user: FediverseUser
|
||||||
|
visibility: Visibility
|
||||||
|
created_at: Optional[str] = None
|
||||||
|
files: List[FediverseFile] = None
|
||||||
|
reply_to_id: Optional[str] = None
|
||||||
|
|
||||||
|
def __post_init__(self):
|
||||||
|
if self.files is None:
|
||||||
|
self.files = []
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class FediverseNotification:
|
||||||
|
"""Common notification representation across Fediverse platforms"""
|
||||||
|
id: str
|
||||||
|
type: NotificationType
|
||||||
|
user: FediverseUser
|
||||||
|
post: Optional[FediversePost] = None
|
||||||
|
created_at: Optional[str] = None
|
172
bot/misskey_service.py
Normal file
172
bot/misskey_service.py
Normal file
|
@ -0,0 +1,172 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
import misskey
|
||||||
|
from typing import List, Optional, Dict, Any, Union, BinaryIO
|
||||||
|
from fediverse_service import FediverseService
|
||||||
|
from fediverse_types import (
|
||||||
|
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
|
||||||
|
NotificationType, Visibility
|
||||||
|
)
|
||||||
|
import config
|
||||||
|
|
||||||
|
|
||||||
|
class MisskeyService(FediverseService):
|
||||||
|
"""Misskey implementation of FediverseService"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.client = misskey.Misskey(address=config.INSTANCE, i=config.KEY)
|
||||||
|
|
||||||
|
def _convert_misskey_user(self, user_data: Dict[str, Any]) -> FediverseUser:
|
||||||
|
"""Convert Misskey user data to FediverseUser"""
|
||||||
|
return FediverseUser(
|
||||||
|
id=user_data.get("id", ""),
|
||||||
|
username=user_data.get("username", "unknown"),
|
||||||
|
host=user_data.get("host"),
|
||||||
|
display_name=user_data.get("name")
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_misskey_file(self, file_data: Dict[str, Any]) -> FediverseFile:
|
||||||
|
"""Convert Misskey file data to FediverseFile"""
|
||||||
|
return FediverseFile(
|
||||||
|
id=file_data.get("id", ""),
|
||||||
|
url=file_data.get("url", ""),
|
||||||
|
type=file_data.get("type"),
|
||||||
|
name=file_data.get("name")
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_misskey_visibility(self, visibility: str) -> Visibility:
|
||||||
|
"""Convert Misskey visibility to our enum"""
|
||||||
|
visibility_map = {
|
||||||
|
"public": Visibility.PUBLIC,
|
||||||
|
"unlisted": Visibility.UNLISTED,
|
||||||
|
"home": Visibility.HOME,
|
||||||
|
"followers": Visibility.FOLLOWERS,
|
||||||
|
"specified": Visibility.SPECIFIED
|
||||||
|
}
|
||||||
|
return visibility_map.get(visibility, Visibility.HOME)
|
||||||
|
|
||||||
|
def _convert_to_misskey_visibility(self, visibility: Visibility) -> str:
|
||||||
|
"""Convert our visibility enum to Misskey visibility"""
|
||||||
|
visibility_map = {
|
||||||
|
Visibility.PUBLIC: "public",
|
||||||
|
Visibility.UNLISTED: "unlisted",
|
||||||
|
Visibility.HOME: "home",
|
||||||
|
Visibility.FOLLOWERS: "followers",
|
||||||
|
Visibility.SPECIFIED: "specified",
|
||||||
|
Visibility.DIRECT: "specified" # Map direct to specified for Misskey
|
||||||
|
}
|
||||||
|
return visibility_map.get(visibility, "home")
|
||||||
|
|
||||||
|
def _convert_misskey_notification_type(self, notif_type: str) -> NotificationType:
|
||||||
|
"""Convert Misskey notification type to our enum"""
|
||||||
|
type_map = {
|
||||||
|
"mention": NotificationType.MENTION,
|
||||||
|
"reply": NotificationType.REPLY,
|
||||||
|
"follow": NotificationType.FOLLOW,
|
||||||
|
"favourite": NotificationType.FAVOURITE,
|
||||||
|
"reblog": NotificationType.REBLOG,
|
||||||
|
"poll": NotificationType.POLL
|
||||||
|
}
|
||||||
|
return type_map.get(notif_type, NotificationType.OTHER)
|
||||||
|
|
||||||
|
def _convert_misskey_post(self, note_data: Dict[str, Any]) -> FediversePost:
|
||||||
|
"""Convert Misskey note data to FediversePost"""
|
||||||
|
files = []
|
||||||
|
if note_data.get("files"):
|
||||||
|
files = [self._convert_misskey_file(f) for f in note_data["files"]]
|
||||||
|
|
||||||
|
return FediversePost(
|
||||||
|
id=note_data.get("id", ""),
|
||||||
|
text=note_data.get("text"),
|
||||||
|
user=self._convert_misskey_user(note_data.get("user", {})),
|
||||||
|
visibility=self._convert_misskey_visibility(note_data.get("visibility", "home")),
|
||||||
|
created_at=note_data.get("createdAt"),
|
||||||
|
files=files,
|
||||||
|
reply_to_id=note_data.get("replyId")
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_misskey_notification(self, notification_data: Dict[str, Any]) -> FediverseNotification:
|
||||||
|
"""Convert Misskey notification data to FediverseNotification"""
|
||||||
|
post = None
|
||||||
|
if notification_data.get("note"):
|
||||||
|
post = self._convert_misskey_post(notification_data["note"])
|
||||||
|
|
||||||
|
return FediverseNotification(
|
||||||
|
id=notification_data.get("id", ""),
|
||||||
|
type=self._convert_misskey_notification_type(notification_data.get("type", "")),
|
||||||
|
user=self._convert_misskey_user(notification_data.get("user", {})),
|
||||||
|
post=post,
|
||||||
|
created_at=notification_data.get("createdAt")
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
|
||||||
|
"""Get notifications from Misskey instance"""
|
||||||
|
params = {
|
||||||
|
'include_types': ['mention', 'reply'],
|
||||||
|
'limit': 50
|
||||||
|
}
|
||||||
|
if since_id:
|
||||||
|
params["since_id"] = since_id
|
||||||
|
|
||||||
|
notifications = self.client.i_notifications(**params)
|
||||||
|
return [self._convert_misskey_notification(notif) for notif in notifications]
|
||||||
|
|
||||||
|
def create_post(
|
||||||
|
self,
|
||||||
|
text: str,
|
||||||
|
reply_to_id: Optional[str] = None,
|
||||||
|
visibility: Visibility = Visibility.HOME,
|
||||||
|
file_ids: Optional[List[str]] = None,
|
||||||
|
visible_user_ids: Optional[List[str]] = None
|
||||||
|
) -> str:
|
||||||
|
"""Create a post on Misskey instance"""
|
||||||
|
params = {
|
||||||
|
"text": text,
|
||||||
|
"visibility": self._convert_to_misskey_visibility(visibility)
|
||||||
|
}
|
||||||
|
|
||||||
|
if reply_to_id:
|
||||||
|
params["reply_id"] = reply_to_id
|
||||||
|
|
||||||
|
if file_ids:
|
||||||
|
params["file_ids"] = file_ids
|
||||||
|
|
||||||
|
if visible_user_ids and visibility == Visibility.SPECIFIED:
|
||||||
|
params["visible_user_ids"] = visible_user_ids
|
||||||
|
|
||||||
|
response = self.client.notes_create(**params)
|
||||||
|
return response.get("createdNote", {}).get("id", "")
|
||||||
|
|
||||||
|
def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
|
||||||
|
"""Get a specific post by ID from Misskey instance"""
|
||||||
|
try:
|
||||||
|
note = self.client.notes_show(noteId=post_id)
|
||||||
|
return self._convert_misskey_post(note)
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
|
||||||
|
"""Upload a file to Misskey Drive"""
|
||||||
|
try:
|
||||||
|
from misskey.exceptions import MisskeyAPIException
|
||||||
|
|
||||||
|
media = self.client.drive_files_create(file_data)
|
||||||
|
return self._convert_misskey_file(media)
|
||||||
|
except MisskeyAPIException as e:
|
||||||
|
raise RuntimeError(f"Failed to upload file to Misskey Drive: {e}") from e
|
||||||
|
except Exception as e:
|
||||||
|
raise RuntimeError(f"Unexpected error during file upload: {e}") from e
|
90
bot/mock_fediverse_service.py
Normal file
90
bot/mock_fediverse_service.py
Normal file
|
@ -0,0 +1,90 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
"""Mock FediverseService for testing purposes"""
|
||||||
|
|
||||||
|
from typing import List, Optional, Union, BinaryIO
|
||||||
|
from fediverse_service import FediverseService
|
||||||
|
from fediverse_types import FediverseNotification, FediversePost, FediverseFile, Visibility
|
||||||
|
|
||||||
|
|
||||||
|
class MockFediverseService(FediverseService):
|
||||||
|
"""Mock implementation of FediverseService for testing"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.notifications = []
|
||||||
|
self.created_posts = []
|
||||||
|
self.uploaded_files = []
|
||||||
|
|
||||||
|
def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
|
||||||
|
"""Return mock notifications, optionally filtered by since_id"""
|
||||||
|
if since_id is None:
|
||||||
|
return self.notifications
|
||||||
|
|
||||||
|
# Filter notifications newer than since_id
|
||||||
|
filtered = []
|
||||||
|
for notif in self.notifications:
|
||||||
|
if notif.id > since_id:
|
||||||
|
filtered.append(notif)
|
||||||
|
return filtered
|
||||||
|
|
||||||
|
def create_post(
|
||||||
|
self,
|
||||||
|
text: str,
|
||||||
|
reply_to_id: Optional[str] = None,
|
||||||
|
visibility: Visibility = Visibility.HOME,
|
||||||
|
file_ids: Optional[List[str]] = None,
|
||||||
|
visible_user_ids: Optional[List[str]] = None
|
||||||
|
) -> str:
|
||||||
|
"""Mock post creation, returns fake post ID"""
|
||||||
|
post_id = f"mock_post_{len(self.created_posts)}"
|
||||||
|
|
||||||
|
# Store the post for assertions
|
||||||
|
self.created_posts.append({
|
||||||
|
'id': post_id,
|
||||||
|
'text': text,
|
||||||
|
'reply_to_id': reply_to_id,
|
||||||
|
'visibility': visibility,
|
||||||
|
'file_ids': file_ids,
|
||||||
|
'visible_user_ids': visible_user_ids
|
||||||
|
})
|
||||||
|
|
||||||
|
return post_id
|
||||||
|
|
||||||
|
def upload_file(self, file_data: Union[BinaryIO, bytes]) -> FediverseFile:
|
||||||
|
"""Mock file upload, returns fake file"""
|
||||||
|
file_id = f"mock_file_{len(self.uploaded_files)}"
|
||||||
|
|
||||||
|
mock_file = FediverseFile(
|
||||||
|
id=file_id,
|
||||||
|
url=f"https://example.com/files/{file_id}",
|
||||||
|
type="image/png",
|
||||||
|
name="test_file.png"
|
||||||
|
)
|
||||||
|
|
||||||
|
self.uploaded_files.append(mock_file)
|
||||||
|
return mock_file
|
||||||
|
|
||||||
|
# Helper methods for testing
|
||||||
|
def add_mock_notification(self, notification: FediverseNotification):
|
||||||
|
"""Add a mock notification for testing"""
|
||||||
|
self.notifications.append(notification)
|
||||||
|
|
||||||
|
def clear_all(self):
|
||||||
|
"""Clear all mock data"""
|
||||||
|
self.notifications.clear()
|
||||||
|
self.created_posts.clear()
|
||||||
|
self.uploaded_files.clear()
|
|
@ -1,115 +1,86 @@
|
||||||
import traceback
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
from misskey.exceptions import MisskeyAPIException
|
# Copyright © 2025 Waifu, Moon, VD15, and contributors.
|
||||||
|
|
||||||
from config import NOTIFICATION_BATCH_SIZE
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
import config
|
||||||
from parsing import parse_notification
|
from parsing import parse_notification
|
||||||
from db_utils import get_config, set_config
|
from db_utils import is_whitelisted, is_player_banned
|
||||||
from response import generate_response
|
from response import generate_response
|
||||||
|
from custom_types import BotResponse
|
||||||
|
from fediverse_factory import get_fediverse_service
|
||||||
|
from fediverse_types import FediverseNotification, NotificationType, Visibility
|
||||||
|
|
||||||
# Define your whitelist
|
|
||||||
# TODO: move to config
|
|
||||||
WHITELISTED_INSTANCES: list[str] = []
|
|
||||||
|
|
||||||
def process_notification(client, notification):
|
def process_fediverse_notification(notification: FediverseNotification, fediverse_service=None) -> None:
|
||||||
'''Processes an individual notification'''
|
'''Processes an individual fediverse notification using the abstraction'''
|
||||||
user = notification.get('user', {})
|
if fediverse_service is None:
|
||||||
username = user.get('username', 'unknown')
|
fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
|
||||||
host = user.get('host') # None if local user
|
|
||||||
|
# Get user and instance info
|
||||||
|
username = notification.user.username
|
||||||
|
host = notification.user.host
|
||||||
instance = host if host else 'local'
|
instance = host if host else 'local'
|
||||||
|
|
||||||
if not (instance in WHITELISTED_INSTANCES or instance == 'local'):
|
# Check whitelist
|
||||||
|
if config.USE_WHITELIST and not is_whitelisted(instance):
|
||||||
print(f'⚠️ Blocked notification from untrusted instance: {instance}')
|
print(f'⚠️ Blocked notification from untrusted instance: {instance}')
|
||||||
return
|
return
|
||||||
|
|
||||||
# Copy visibility of the post that was received when replying (so if people
|
# Only process mentions and replies
|
||||||
# don't want to dump a bunch of notes on home they don't have to)
|
if notification.type not in (NotificationType.MENTION, NotificationType.REPLY):
|
||||||
visibility = notification['note']['visibility']
|
return
|
||||||
if visibility != 'specified':
|
|
||||||
visibility = 'home'
|
|
||||||
|
|
||||||
notif_type = notification.get('type', 'unknown')
|
# Return early if no post attached
|
||||||
notif_id = notification.get('id')
|
if not notification.post:
|
||||||
|
return
|
||||||
|
|
||||||
|
# Determine visibility for reply
|
||||||
|
if notification.post.visibility != Visibility.SPECIFIED:
|
||||||
|
visibility = Visibility.HOME
|
||||||
|
else:
|
||||||
|
visibility = Visibility.SPECIFIED
|
||||||
|
|
||||||
|
notif_type = notification.type.value
|
||||||
|
notif_id = notification.id
|
||||||
print(f'📨 <{notif_id}> [{notif_type}] from @{username}@{instance}')
|
print(f'📨 <{notif_id}> [{notif_type}] from @{username}@{instance}')
|
||||||
|
|
||||||
# 🧠 Send to the parser
|
# 🧠 Send to the parser
|
||||||
parsed_command = parse_notification(notification, client)
|
parsed_notification = parse_notification(notification, fediverse_service)
|
||||||
|
|
||||||
# Get the note Id to reply to
|
if not parsed_notification:
|
||||||
note_id = notification.get('note', {}).get('id')
|
return
|
||||||
|
|
||||||
|
author = parsed_notification['author']
|
||||||
|
if is_player_banned(author):
|
||||||
|
print(f'⚠️ Blocked notification from banned player: {author}')
|
||||||
|
return
|
||||||
|
|
||||||
# Get the response
|
# Get the response
|
||||||
# TODO: Formalize exactly *what* is returned by this. Ideally just want to
|
response: BotResponse | None = generate_response(parsed_notification)
|
||||||
# handle two cases here: either we have a response, or we don't.
|
|
||||||
# TODO: Return dictionaries instead of tuples. They handle multiple
|
if not response:
|
||||||
# elements a lot better as they're not position dependent
|
return
|
||||||
response = generate_response(parsed_command)
|
|
||||||
if isinstance(response, str):
|
# Handle attachment URLs (convert to file IDs if needed)
|
||||||
client.notes_create(
|
file_ids = response['attachment_urls'] if response['attachment_urls'] else None
|
||||||
text=response,
|
|
||||||
reply_id=note_id,
|
# Send response using fediverse service
|
||||||
visibility=visibility
|
fediverse_service.create_post(
|
||||||
)
|
text=response['message'],
|
||||||
elif response:
|
reply_to_id=notification.post.id,
|
||||||
client.notes_create(
|
|
||||||
text=response[0],
|
|
||||||
reply_id=note_id,
|
|
||||||
visibility=visibility,
|
visibility=visibility,
|
||||||
file_ids=response[1]
|
file_ids=file_ids
|
||||||
#visible_user_ids=[] #todo: write actual visible users ids so pleromers can use the bot privately
|
# visible_user_ids=[] # TODO: write actual visible users ids so pleromers can use the bot privately
|
||||||
)
|
)
|
||||||
|
|
||||||
def process_notifications(client):
|
|
||||||
'''Processes a batch of unread notifications. Returns False if there are
|
|
||||||
no more notifications to process.'''
|
|
||||||
|
|
||||||
last_seen_id = get_config('last_seen_notif_id')
|
|
||||||
# process_notification writes to last_seen_id, so make a copy
|
|
||||||
new_last_seen_id = last_seen_id
|
|
||||||
|
|
||||||
try:
|
|
||||||
notifications = client.i_notifications(
|
|
||||||
# Fetch notifications we haven't seen yet. This option is a bit
|
|
||||||
# tempermental, sometimes it'll include since_id, sometimes it
|
|
||||||
# won't. We need to keep track of what notifications we've
|
|
||||||
# already processed.
|
|
||||||
since_id=last_seen_id,
|
|
||||||
# Let misskey handle the filtering
|
|
||||||
include_types=['mention', 'reply'],
|
|
||||||
# And handle the batch size while we're at it
|
|
||||||
limit=NOTIFICATION_BATCH_SIZE
|
|
||||||
)
|
|
||||||
|
|
||||||
# No notifications. Wait the poll period.
|
|
||||||
if not notifications:
|
|
||||||
return False
|
|
||||||
|
|
||||||
# Iterate oldest to newest
|
|
||||||
for notification in notifications:
|
|
||||||
try:
|
|
||||||
# Skip if we've processed already
|
|
||||||
notif_id = notification.get('id')
|
|
||||||
if notif_id <= last_seen_id:
|
|
||||||
continue
|
|
||||||
|
|
||||||
# Update new_last_seen_id and process
|
|
||||||
new_last_seen_id = notif_id
|
|
||||||
process_notification(client, notification)
|
|
||||||
|
|
||||||
except Exception as e:
|
|
||||||
print(f'An exception has occured while processing a notification: {e}')
|
|
||||||
print(traceback.format_exc())
|
|
||||||
|
|
||||||
# If we got as many notifications as we requested, there are probably
|
|
||||||
# more in the queue
|
|
||||||
return len(notifications) == NOTIFICATION_BATCH_SIZE
|
|
||||||
|
|
||||||
except MisskeyAPIException as e:
|
|
||||||
print(f'An exception has occured while reading notifications: {e}\n')
|
|
||||||
print(traceback.format_exc())
|
|
||||||
finally:
|
|
||||||
# Quality jank right here, but finally lets us update the last_seen_id
|
|
||||||
# even if we hit an exception or return early
|
|
||||||
if new_last_seen_id > last_seen_id:
|
|
||||||
set_config('last_seen_notif_id', new_last_seen_id)
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
101
bot/parsing.py
101
bot/parsing.py
|
@ -1,24 +1,58 @@
|
||||||
import random, re
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu, Moon, VD15, and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
import re
|
||||||
import config
|
import config
|
||||||
|
from response import generate_response
|
||||||
|
from fediverse_factory import get_fediverse_service
|
||||||
|
from fediverse_types import FediverseNotification, NotificationType, Visibility
|
||||||
|
from custom_types import ParsedNotification
|
||||||
|
|
||||||
def parse_notification(notification,client):
|
def parse_notification(notification: FediverseNotification, fediverse_service=None):
|
||||||
'''Parses any notifications received by the bot and sends any commands to
|
'''Parses any notifications received by the bot and sends any commands to
|
||||||
gacha_response()'''
|
generate_response()'''
|
||||||
|
|
||||||
|
if fediverse_service is None:
|
||||||
|
fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
|
||||||
|
|
||||||
|
# We get the type of notification to filter the ones that we actually want
|
||||||
|
# to parse
|
||||||
|
if notification.type not in (NotificationType.MENTION, NotificationType.REPLY):
|
||||||
|
return # Ignore anything that isn't a mention
|
||||||
|
|
||||||
|
# Return early if no post attached
|
||||||
|
if not notification.post:
|
||||||
|
return
|
||||||
|
|
||||||
|
# We want the visibility to be related to the type that was received (so if
|
||||||
|
# people don't want to dump a bunch of notes on home they don't have to)
|
||||||
|
if notification.post.visibility != Visibility.SPECIFIED:
|
||||||
|
visibility = Visibility.HOME
|
||||||
|
else:
|
||||||
|
visibility = Visibility.SPECIFIED
|
||||||
|
|
||||||
# Get the full Activitypub ID of the user
|
# Get the full Activitypub ID of the user
|
||||||
user = notification.get("user", {})
|
full_user = notification.user.full_handle
|
||||||
username = user.get("username", "unknown")
|
|
||||||
host = user.get("host")
|
|
||||||
# Local users may not have a hostname attached
|
|
||||||
full_user = f"@{username}" if not host else f"@{username}@{host}"
|
|
||||||
|
|
||||||
note_obj = notification.get("note", {})
|
note_text = notification.post.text
|
||||||
note_text = note_obj.get("text")
|
note_id = notification.post.id
|
||||||
note_id = note_obj.get("id")
|
|
||||||
|
|
||||||
note = note_text.strip().lower() if note_text else ""
|
note = note_text.strip().lower() if note_text else ""
|
||||||
|
# Split words into tokens
|
||||||
|
parts = note.split()
|
||||||
|
|
||||||
# Check for both short and fully-qualified name mentions
|
# Check for both short and fully-qualified name mentions
|
||||||
username_variants = [
|
username_variants = [
|
||||||
|
@ -26,16 +60,41 @@ def parse_notification(notification,client):
|
||||||
f'@{config.USER.split("@")[1]}'
|
f'@{config.USER.split("@")[1]}'
|
||||||
]
|
]
|
||||||
|
|
||||||
# Make sure the notification text explicitly mentions the bot
|
# Notifs must consist of the initial mention and at least one other token
|
||||||
if not any(variant in note for variant in username_variants):
|
if len(parts) <= 1:
|
||||||
|
return None
|
||||||
|
|
||||||
|
# Make sure the first token is a mention to the bot
|
||||||
|
if not parts[0] in username_variants:
|
||||||
|
return None
|
||||||
|
|
||||||
|
command = parts[1].lower()
|
||||||
|
arguments = parts[2:] if len(parts) > 2 else []
|
||||||
|
|
||||||
|
# Create ParsedNotification object for the new response system
|
||||||
|
parsed_notification: ParsedNotification = {
|
||||||
|
'author': full_user,
|
||||||
|
'command': command,
|
||||||
|
'arguments': arguments,
|
||||||
|
'note_obj': {
|
||||||
|
'id': note_id,
|
||||||
|
'text': note_text,
|
||||||
|
'files': [{'url': f.url} for f in notification.post.files] if notification.post.files else []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Generate response using the new system
|
||||||
|
response = generate_response(parsed_notification)
|
||||||
|
if not response:
|
||||||
return
|
return
|
||||||
|
|
||||||
# Find command and arguments after the mention
|
# Handle attachment URLs (convert to file IDs if needed)
|
||||||
# Removes all mentions (regex = mentions that start with @ and may contain @domain)
|
file_ids = response['attachment_urls'] if response['attachment_urls'] else None
|
||||||
cleaned_text = re.sub(r"@\w+(?:@\S+)?", "", note).strip()
|
|
||||||
parts = cleaned_text.split()
|
|
||||||
|
|
||||||
command = parts[0].lower() if parts else None
|
fediverse_service.create_post(
|
||||||
arguments = parts[1:] if len(parts) > 1 else []
|
text=response['message'],
|
||||||
|
reply_to_id=note_id,
|
||||||
return [command,full_user, arguments, note_obj]
|
visibility=visibility,
|
||||||
|
file_ids=file_ids
|
||||||
|
#visible_user_ids=[] #todo: write actual visible users ids so pleromers can use the bot privately
|
||||||
|
)
|
||||||
|
|
204
bot/pleroma_service.py
Normal file
204
bot/pleroma_service.py
Normal file
|
@ -0,0 +1,204 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Moon and contributors.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
from mastodon import Mastodon
|
||||||
|
from typing import List, Optional, Dict, Any, Union, BinaryIO
|
||||||
|
import io
|
||||||
|
import filetype
|
||||||
|
from fediverse_service import FediverseService
|
||||||
|
from fediverse_types import (
|
||||||
|
FediverseNotification, FediversePost, FediverseUser, FediverseFile,
|
||||||
|
NotificationType, Visibility
|
||||||
|
)
|
||||||
|
import config
|
||||||
|
|
||||||
|
|
||||||
|
class PleromaService(FediverseService):
|
||||||
|
"""Pleroma implementation of FediverseService using Mastodon.py"""
|
||||||
|
|
||||||
|
def __init__(self):
|
||||||
|
self.client = Mastodon(
|
||||||
|
access_token=config.KEY,
|
||||||
|
api_base_url=config.INSTANCE
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_mastodon_user(self, user_data: Dict[str, Any]) -> FediverseUser:
|
||||||
|
"""Convert Mastodon/Pleroma user data to FediverseUser"""
|
||||||
|
acct = user_data.get("acct", "")
|
||||||
|
if "@" in acct:
|
||||||
|
username, host = acct.split("@", 1)
|
||||||
|
else:
|
||||||
|
username = acct
|
||||||
|
host = None
|
||||||
|
|
||||||
|
return FediverseUser(
|
||||||
|
id=str(user_data.get("id", "")),
|
||||||
|
username=username,
|
||||||
|
host=host,
|
||||||
|
display_name=user_data.get("display_name")
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_mastodon_file(self, file_data: Dict[str, Any]) -> FediverseFile:
|
||||||
|
"""Convert Mastodon/Pleroma media attachment to FediverseFile"""
|
||||||
|
return FediverseFile(
|
||||||
|
id=str(file_data.get("id", "")),
|
||||||
|
url=file_data.get("url", ""),
|
||||||
|
type=file_data.get("type"),
|
||||||
|
name=file_data.get("description")
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_mastodon_visibility(self, visibility: str) -> Visibility:
|
||||||
|
"""Convert Mastodon/Pleroma visibility to our enum"""
|
||||||
|
visibility_map = {
|
||||||
|
"public": Visibility.PUBLIC,
|
||||||
|
"unlisted": Visibility.UNLISTED,
|
||||||
|
"private": Visibility.FOLLOWERS,
|
||||||
|
"direct": Visibility.DIRECT
|
||||||
|
}
|
||||||
|
return visibility_map.get(visibility, Visibility.PUBLIC)
|
||||||
|
|
||||||
|
def _convert_to_mastodon_visibility(self, visibility: Visibility) -> str:
|
||||||
|
"""Convert our visibility enum to Mastodon/Pleroma visibility"""
|
||||||
|
visibility_map = {
|
||||||
|
Visibility.PUBLIC: "public",
|
||||||
|
Visibility.UNLISTED: "unlisted",
|
||||||
|
Visibility.HOME: "unlisted", # Map home to unlisted for Pleroma
|
||||||
|
Visibility.FOLLOWERS: "private",
|
||||||
|
Visibility.SPECIFIED: "direct", # Map specified to direct for Pleroma
|
||||||
|
Visibility.DIRECT: "direct"
|
||||||
|
}
|
||||||
|
return visibility_map.get(visibility, "public")
|
||||||
|
|
||||||
|
def _convert_mastodon_notification_type(self, notif_type: str) -> NotificationType:
|
||||||
|
"""Convert Mastodon/Pleroma notification type to our enum"""
|
||||||
|
type_map = {
|
||||||
|
"mention": NotificationType.MENTION,
|
||||||
|
"follow": NotificationType.FOLLOW,
|
||||||
|
"favourite": NotificationType.FAVOURITE,
|
||||||
|
"reblog": NotificationType.REBLOG,
|
||||||
|
"poll": NotificationType.POLL
|
||||||
|
}
|
||||||
|
return type_map.get(notif_type, NotificationType.OTHER)
|
||||||
|
|
||||||
|
def _convert_mastodon_status(self, status_data: Dict[str, Any]) -> FediversePost:
|
||||||
|
"""Convert Mastodon/Pleroma status data to FediversePost"""
|
||||||
|
files = []
|
||||||
|
if status_data.get("media_attachments"):
|
||||||
|
files = [self._convert_mastodon_file(f) for f in status_data["media_attachments"]]
|
||||||
|
|
||||||
|
# Extract plain text from HTML content
|
||||||
|
content = status_data.get("content", "")
|
||||||
|
# Basic HTML stripping - in production you might want to use a proper HTML parser
|
||||||
|
import re
|
||||||
|
plain_text = re.sub(r'<[^>]+>', '', content) if content else None
|
||||||
|
|
||||||
|
return FediversePost(
|
||||||
|
id=str(status_data.get("id", "")),
|
||||||
|
text=plain_text,
|
||||||
|
user=self._convert_mastodon_user(status_data.get("account", {})),
|
||||||
|
visibility=self._convert_mastodon_visibility(status_data.get("visibility", "public")),
|
||||||
|
created_at=status_data.get("created_at"),
|
||||||
|
files=files,
|
||||||
|
reply_to_id=str(status_data["in_reply_to_id"]) if status_data.get("in_reply_to_id") else None
|
||||||
|
)
|
||||||
|
|
||||||
|
def _convert_mastodon_notification(self, notification_data: Dict[str, Any]) -> FediverseNotification:
|
||||||
|
"""Convert Mastodon/Pleroma notification data to FediverseNotification"""
|
||||||
|
post = None
|
||||||
|
if notification_data.get("status"):
|
||||||
|
post = self._convert_mastodon_status(notification_data["status"])
|
||||||
|
|
||||||
|
return FediverseNotification(
|
||||||
|
id=str(notification_data.get("id", "")),
|
||||||
|
type=self._convert_mastodon_notification_type(notification_data.get("type", "")),
|
||||||
|
user=self._convert_mastodon_user(notification_data.get("account", {})),
|
||||||
|
post=post,
|
||||||
|
created_at=notification_data.get("created_at")
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_notifications(self, since_id: Optional[str] = None) -> List[FediverseNotification]:
|
||||||
|
"""Get notifications from Pleroma instance"""
|
||||||
|
params = {}
|
||||||
|
if since_id:
|
||||||
|
params["since_id"] = since_id
|
||||||
|
|
||||||
|
notifications = self.client.notifications(**params)
|
||||||
|
return [self._convert_mastodon_notification(notif) for notif in notifications]
|
||||||
|
|
||||||
|
def create_post(
|
||||||
|
self,
|
||||||
|
text: str,
|
||||||
|
reply_to_id: Optional[str] = None,
|
||||||
|
visibility: Visibility = Visibility.HOME,
|
||||||
|
file_ids: Optional[List[str]] = None,
|
||||||
|
visible_user_ids: Optional[List[str]] = None
|
||||||
|
) -> str:
|
||||||
|
"""Create a post on Pleroma instance"""
|
||||||
|
params = {
|
||||||
|
"status": text,
|
||||||
|
"visibility": self._convert_to_mastodon_visibility(visibility)
|
||||||
|
}
|
||||||
|
|
||||||
|
if reply_to_id:
|
||||||
|
params["in_reply_to_id"] = reply_to_id
|
||||||
|
|
||||||
|
if file_ids:
|
||||||
|
params["media_ids"] = file_ids
|
||||||
|
|
||||||
|
# Note: Pleroma/Mastodon doesn't have direct equivalent to visible_user_ids
|
||||||
|
# For direct messages, you typically mention users in the status text
|
||||||
|
|
||||||
|
response = self.client.status_post(**params)
|
||||||
|
return str(response.get("id", ""))
|
||||||
|
|
||||||
|
def get_post_by_id(self, post_id: str) -> Optional[FediversePost]:
|
||||||
|
"""Get a specific post by ID from Pleroma instance"""
|
||||||
|
try:
|
||||||
|
status = self.client.status(post_id)
|
||||||
|
return self._convert_mastodon_status(status)
|
||||||
|
except Exception:
|
||||||
|
return None
|
||||||
|
|
||||||
|
def upload_file(self, file_data: Union[BinaryIO, bytes], filename: Optional[str] = None) -> FediverseFile:
|
||||||
|
"""Upload a file to Pleroma instance"""
|
||||||
|
try:
|
||||||
|
# Convert file_data to bytes for MIME detection
|
||||||
|
if hasattr(file_data, 'read'):
|
||||||
|
# Check if we can seek back
|
||||||
|
try:
|
||||||
|
current_pos = file_data.tell()
|
||||||
|
file_bytes = file_data.read()
|
||||||
|
file_data.seek(current_pos)
|
||||||
|
file_data = io.BytesIO(file_bytes)
|
||||||
|
except (io.UnsupportedOperation, OSError):
|
||||||
|
# Non-seekable stream, already read all data
|
||||||
|
file_data = io.BytesIO(file_bytes)
|
||||||
|
else:
|
||||||
|
file_bytes = file_data
|
||||||
|
file_data = io.BytesIO(file_bytes)
|
||||||
|
|
||||||
|
# Use filetype library for robust MIME detection
|
||||||
|
kind = filetype.guess(file_bytes)
|
||||||
|
if kind is not None:
|
||||||
|
mime_type = kind.mime
|
||||||
|
else:
|
||||||
|
# Fallback to image/jpeg if detection fails
|
||||||
|
mime_type = 'image/jpeg'
|
||||||
|
|
||||||
|
media = self.client.media_post(file_data, mime_type=mime_type, description=filename)
|
||||||
|
return self._convert_mastodon_file(media)
|
||||||
|
except Exception as e:
|
||||||
|
raise RuntimeError(f"Failed to upload file to Pleroma: {e}") from e
|
318
bot/response.py
318
bot/response.py
|
@ -1,20 +1,44 @@
|
||||||
|
#Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
#Copyright © 2025 Waifu, VD15 and contributors.
|
||||||
|
#
|
||||||
|
#This program is free software: you can redistribute it and/or modify
|
||||||
|
#it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
#You should have received a copy of the GNU Affero General Public License
|
||||||
|
#along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
from datetime import datetime, timedelta, timezone
|
from datetime import datetime, timedelta, timezone
|
||||||
from db_utils import get_or_create_user, insert_pull, get_last_rolled_at, get_random_character
|
from typing import TypedDict, Any, List, Dict
|
||||||
from add_character import add_character
|
import db_utils as db
|
||||||
|
from add_card import add_card
|
||||||
from config import GACHA_ROLL_INTERVAL
|
from config import GACHA_ROLL_INTERVAL
|
||||||
|
from custom_types import BotResponse, ParsedNotification
|
||||||
|
|
||||||
def do_roll(full_user):
|
|
||||||
'''Determines whether the user can roll, then pulls a random character'''
|
|
||||||
user_id = get_or_create_user(full_user)
|
|
||||||
|
|
||||||
|
def do_roll(author: str) -> BotResponse:
|
||||||
|
'''Determines whether the user can roll, then pulls a random card'''
|
||||||
|
user_id = db.get_player(author)
|
||||||
|
if not user_id:
|
||||||
|
return {
|
||||||
|
'message': f'{author} 🛑 You haven’t signed up yet! Use the \
|
||||||
|
`signup` command to start playing.',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
# Get date of user's last roll
|
# Get date of user's last roll
|
||||||
date = get_last_rolled_at(user_id)
|
date = db.get_last_rolled_at(user_id)
|
||||||
|
|
||||||
# No date means it's users first roll
|
# No date means it's users first roll
|
||||||
if date:
|
if date:
|
||||||
# SQLite timestamps returned by the DB are always in UTC
|
# SQLite timestamps returned by the DB are always in UTC
|
||||||
# Below timestamps are to be converted to UTC
|
# Below timestamps are to be converted to UTC
|
||||||
prev = datetime.strptime(date + '+0000', '%Y-%m-%d %H:%M:%S%z')
|
prev = datetime.strptime(str(date) + '+0000', '%Y-%m-%d %H:%M:%S%z')
|
||||||
now = datetime.now(timezone.utc)
|
now = datetime.now(timezone.utc)
|
||||||
|
|
||||||
time_since_last_roll = now - prev
|
time_since_last_roll = now - prev
|
||||||
|
@ -31,19 +55,50 @@ def do_roll(full_user):
|
||||||
else:
|
else:
|
||||||
remaining_duration = f'{duration.seconds} seconds'
|
remaining_duration = f'{duration.seconds} seconds'
|
||||||
|
|
||||||
return f'{full_user} ⏱️ Please wait another {remaining_duration} before rolling again.'
|
return {
|
||||||
|
'message': f'{author} ⏱️ Please wait another \
|
||||||
|
{remaining_duration} before rolling again.',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
character_id, character_name, file_id, rarity = get_random_character()
|
card = db.get_random_card()
|
||||||
|
|
||||||
if not character_id:
|
if not card:
|
||||||
return f'{full_user} Uwaaa... something went wrong! No characters found. 😿'
|
return {
|
||||||
|
'message': f'{author} Uwaaa... something went wrong! No \
|
||||||
|
cards found. 😿',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
insert_pull(user_id,character_id)
|
db.insert_pull(user_id, card['id'])
|
||||||
stars = '⭐️' * rarity
|
stars = '⭐️' * card['rarity']
|
||||||
return([f"@{full_user} 🎲 Congrats! You rolled {stars} **{character_name}**\n\
|
return {
|
||||||
She's all yours now~ 💖✨",[file_id]])
|
'message': f'{author} 🎲 Congrats! You rolled {stars} \
|
||||||
|
**{card['name']}**\nShe\'s all yours now~ 💖✨',
|
||||||
|
'attachment_urls': [card['image_url']]
|
||||||
|
}
|
||||||
|
|
||||||
def is_float(val):
|
|
||||||
|
def do_signup(author: str) -> BotResponse:
|
||||||
|
'''Registers a new user if they haven’t signed up yet.'''
|
||||||
|
user_id = db.get_player(author)
|
||||||
|
|
||||||
|
if user_id:
|
||||||
|
return {
|
||||||
|
'message': f'{author} 👀 You’re already signed up! Let the rolling \
|
||||||
|
begin~ 🎲',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
new_user_id = db.insert_player(author)
|
||||||
|
return {
|
||||||
|
'message': f'{author} ✅ Signed up successfully! Your gacha \
|
||||||
|
destiny begins now... ✨ Use the roll command to start!',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def is_float(val: Any) -> bool:
|
||||||
'''Returns true if `val` can be converted to a float'''
|
'''Returns true if `val` can be converted to a float'''
|
||||||
try:
|
try:
|
||||||
float(val)
|
float(val)
|
||||||
|
@ -51,50 +106,223 @@ def is_float(val):
|
||||||
except ValueError:
|
except ValueError:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def do_create(full_user, arguments, note_obj):
|
|
||||||
'''Creates a character'''
|
|
||||||
# Example call from bot logic
|
|
||||||
image_url = note_obj.get('files', [{}])[0].get('url') if note_obj.get('files') else None
|
|
||||||
if not image_url:
|
|
||||||
return f'{full_user}{full_user} You need an image to create a character, dumbass.'
|
|
||||||
|
|
||||||
if len(arguments) != 3:
|
def do_create(
|
||||||
return '{full_user}Please specify the following attributes in order: \
|
author: str,
|
||||||
name, rarity, drop weighting'
|
arguments: List[str],
|
||||||
|
note_obj: Dict[str, Any]) -> BotResponse:
|
||||||
|
'''Creates a card'''
|
||||||
|
# Example call from bot logic
|
||||||
|
image_url = note_obj.get('files', [{}])[0].get('url') \
|
||||||
|
if note_obj.get('files') else None
|
||||||
|
|
||||||
|
if not image_url:
|
||||||
|
return {
|
||||||
|
'message': f'{author} You need an image to create a card, \
|
||||||
|
dumbass.',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if len(arguments) != 2:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Please specify the following attributes \
|
||||||
|
in order: name, rarity',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
if not (arguments[1].isnumeric() and 1 <= int(arguments[1]) <= 5):
|
if not (arguments[1].isnumeric() and 1 <= int(arguments[1]) <= 5):
|
||||||
return f'{full_user}Invalid rarity: \'{arguments[1]}\' must be a number between 1 and 5'
|
return {
|
||||||
|
'message': f'{author} Invalid rarity: \'{arguments[1]}\' must \
|
||||||
|
be a number between 1 and 5',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
if not (is_float(arguments[2]) and 0.0 < float(arguments[2]) <= 1.0):
|
card_id, file_id = add_card(
|
||||||
return f'{full_user}Invalid drop weight: \'{arguments[2]}\' \
|
|
||||||
must be a decimal value between 0.0 and 1.0'
|
|
||||||
|
|
||||||
character_id, file_id = add_character(
|
|
||||||
name=arguments[0],
|
name=arguments[0],
|
||||||
rarity=int(arguments[1]),
|
rarity=int(arguments[1]),
|
||||||
weight=float(arguments[2]),
|
|
||||||
image_url=image_url
|
image_url=image_url
|
||||||
)
|
)
|
||||||
return([f'{full_user}Added {arguments[0]}, ID {character_id}.',[file_id]])
|
return {
|
||||||
|
'message': f'{author} Added {arguments[0]}, ID {card_id}.',
|
||||||
|
'attachment_urls': [file_id]
|
||||||
|
}
|
||||||
|
|
||||||
def do_help(full_user):
|
|
||||||
|
def do_help(author: str) -> BotResponse:
|
||||||
'''Provides a list of commands that the bot can do.'''
|
'''Provides a list of commands that the bot can do.'''
|
||||||
return f'{full_user} Here\'s what I can do:\n \
|
return {
|
||||||
- `roll` Pulls a random character.\
|
'message': f'{author} Here\'s what I can do:\n\
|
||||||
- `create <name> <rarity> <weight>` Creates a character using a given image.\
|
- `roll` Pulls a random card.\n\
|
||||||
- `help` Shows this message'
|
- `create <name> <rarity>` Creates a card using a given image.\n\
|
||||||
|
- `signup` Registers your account.\n\
|
||||||
|
- `delete_account` Deletes your account.\n\
|
||||||
|
- `help` Shows this message',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
def generate_response(parsed_command):
|
|
||||||
|
def delete_account(author: str) -> BotResponse:
|
||||||
|
return {
|
||||||
|
'message': f'{author} ⚠️ This will permanently delete your account \
|
||||||
|
and all your cards.\n'
|
||||||
|
'If you\'re sure, reply with `confirm_delete_account` to proceed.\n\n'
|
||||||
|
'**There is no undo.** Your gacha luck will be lost to the void... 💀✨',
|
||||||
|
'attachment_urls': None
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def confirm_delete(author: str) -> BotResponse:
|
||||||
|
db.delete_player(author)
|
||||||
|
|
||||||
|
return {
|
||||||
|
'message': f'{author} 🧼 Your account and all your cards have been \
|
||||||
|
deleted. RIP your gacha history 🕊️✨',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def do_whitelist(author: str, args: list[str]) -> BotResponse:
|
||||||
|
if len(args) == 0:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Please specify an instance to whitelist',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if db.add_to_whitelist(args[0]):
|
||||||
|
return {
|
||||||
|
'message': f'{author} Whitelisted instance: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Instance already whitelisted: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def do_unwhitelist(author: str, args: list[str]) -> BotResponse:
|
||||||
|
if len(args) == 0:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Please specify an instance to remove from \
|
||||||
|
the whitelist',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if db.remove_from_whitelist(args[0]):
|
||||||
|
return {
|
||||||
|
'message': f'{author} Unwhitelisted instance: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Instance not whitelisted: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def do_ban(author: str, args: list[str]) -> BotResponse:
|
||||||
|
if len(args) == 0:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Please specify a user to ban',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if db.is_player_administrator(args[0]):
|
||||||
|
return {
|
||||||
|
'message': f'{author} Cannot ban other administrators.',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if db.ban_player(args[0]):
|
||||||
|
# Delete banned player's account
|
||||||
|
db.delete_player(args[0])
|
||||||
|
return {
|
||||||
|
'message': f'{author} 🔨 **BONK!** Get banned, {args[0]}!',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Player is already banned: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def do_unban(author: str, args: list[str]) -> BotResponse:
|
||||||
|
if len(args) == 0:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Please specify a user to unban',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
if db.unban_player(args[0]):
|
||||||
|
return {
|
||||||
|
'message': f'{author} Player unbanned: {args[0]}!',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
else:
|
||||||
|
return {
|
||||||
|
'message': f'{author} Player was not banned: {args[0]}',
|
||||||
|
'attachment_urls': None
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def generate_response(notification: ParsedNotification) -> BotResponse | None:
|
||||||
'''Given a command with arguments, processes the game state and
|
'''Given a command with arguments, processes the game state and
|
||||||
returns a response'''
|
returns a response'''
|
||||||
|
|
||||||
command, full_user, arguments, note_obj = parsed_command
|
# Temporary response variable
|
||||||
|
res: BotResponse | None = None
|
||||||
|
author = notification['author']
|
||||||
|
player_id = db.get_player(author)
|
||||||
|
command = notification['command']
|
||||||
|
|
||||||
|
# Unrestricted commands
|
||||||
match command:
|
match command:
|
||||||
case 'roll':
|
case 'roll':
|
||||||
return do_roll(full_user)
|
res = do_roll(author)
|
||||||
case 'create':
|
case 'signup':
|
||||||
return do_create(full_user, arguments, note_obj)
|
res = do_signup(author)
|
||||||
case 'help':
|
case 'help':
|
||||||
return do_help(command)
|
res = do_help(author)
|
||||||
case _:
|
case _:
|
||||||
return None
|
pass
|
||||||
|
|
||||||
|
# Commands beyond this point require the user to have an account
|
||||||
|
if not player_id:
|
||||||
|
return res
|
||||||
|
|
||||||
|
# User commands
|
||||||
|
match command:
|
||||||
|
case 'create':
|
||||||
|
res = do_create(
|
||||||
|
author,
|
||||||
|
notification['arguments'],
|
||||||
|
notification['note_obj']
|
||||||
|
)
|
||||||
|
case 'delete_account':
|
||||||
|
res = delete_account(author)
|
||||||
|
case 'confirm_delete_account':
|
||||||
|
res = confirm_delete(author)
|
||||||
|
case _:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Commands beyond this point require the user to be an administrator
|
||||||
|
if not db.is_player_administrator(author):
|
||||||
|
return res
|
||||||
|
|
||||||
|
# Admin commands
|
||||||
|
match command:
|
||||||
|
case 'whitelist':
|
||||||
|
res = do_whitelist(author, notification['arguments'])
|
||||||
|
case 'unwhitelist':
|
||||||
|
res = do_unwhitelist(author, notification['arguments'])
|
||||||
|
case 'ban':
|
||||||
|
res = do_ban(author, notification['arguments'])
|
||||||
|
case 'unban':
|
||||||
|
res = do_unban(author, notification['arguments'])
|
||||||
|
case _:
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Administrator commands go here
|
||||||
|
return res
|
||||||
|
|
49
contributing.md
Normal file
49
contributing.md
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Contributing to Kemoverse
|
||||||
|
|
||||||
|
Contributions are welcome with the following requirements:
|
||||||
|
|
||||||
|
## Licensing
|
||||||
|
|
||||||
|
- All contributions must be licensed under the **AGPLv3-or-later** or a compatible license.
|
||||||
|
- If you include code from another project (e.g., MIT Expat), please **list the license and copyright holders** clearly.
|
||||||
|
- If your contribution introduces code under a different license, you **must clarify this**, so the project can remain license-compliant.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
- Please **add your name** to the license header of any file where you’ve made a **nontrivial change**.
|
||||||
|
- Nontrivial changes include:
|
||||||
|
- New features
|
||||||
|
- Logic changes
|
||||||
|
- Major refactoring or structure changes
|
||||||
|
- Not: typo fixes or simple reformatting
|
||||||
|
|
||||||
|
## Commit Messages (optional but appreciated)
|
||||||
|
|
||||||
|
- Try to write clear, descriptive commit messages.
|
||||||
|
|
||||||
|
## Communication
|
||||||
|
|
||||||
|
- If you're planning a major change or feature, please open an issue or contact the maintainers first.
|
||||||
|
- This helps avoid duplicated work and makes collaboration easier.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Thank you for helping grow the Kemoverse 💫
|
73
db.py
73
db.py
|
@ -1,73 +0,0 @@
|
||||||
import sqlite3
|
|
||||||
|
|
||||||
# Connect to SQLite database (or create it if it doesn't exist)
|
|
||||||
conn = sqlite3.connect('gacha_game.db')
|
|
||||||
cursor = conn.cursor()
|
|
||||||
|
|
||||||
# Create tables
|
|
||||||
cursor.execute('''
|
|
||||||
CREATE TABLE IF NOT EXISTS users (
|
|
||||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
||||||
username TEXT UNIQUE NOT NULL,
|
|
||||||
has_rolled BOOLEAN NOT NULL DEFAULT 0
|
|
||||||
)
|
|
||||||
''')
|
|
||||||
|
|
||||||
cursor.execute('''
|
|
||||||
CREATE TABLE IF NOT EXISTS characters (
|
|
||||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
rarity INTEGER NOT NULL,
|
|
||||||
weight REAL NOT NULL,
|
|
||||||
file_id TEXT NOT NULL
|
|
||||||
)
|
|
||||||
''')
|
|
||||||
|
|
||||||
cursor.execute('''
|
|
||||||
CREATE TABLE IF NOT EXISTS pulls (
|
|
||||||
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
|
||||||
user_id INTEGER,
|
|
||||||
character_id INTEGER,
|
|
||||||
timestamp DATETIME DEFAULT CURRENT_TIMESTAMP,
|
|
||||||
FOREIGN KEY (user_id) REFERENCES users(id),
|
|
||||||
FOREIGN KEY (character_id) REFERENCES characters(id)
|
|
||||||
)
|
|
||||||
''')
|
|
||||||
|
|
||||||
cursor.execute("""
|
|
||||||
CREATE TABLE IF NOT EXISTS config (
|
|
||||||
key TEXT PRIMARY KEY,
|
|
||||||
value TEXT
|
|
||||||
)
|
|
||||||
""")
|
|
||||||
|
|
||||||
cursor.execute('''
|
|
||||||
CREATE TABLE IF NOT EXISTS character_stats (
|
|
||||||
character_id INTEGER PRIMARY KEY,
|
|
||||||
power INTEGER NOT NULL DEFAULT abs(random() % 9999),
|
|
||||||
charm INTEGER NOT NULL DEFAULT abs(random() % 9999),,
|
|
||||||
FOREIGN KEY(character_id) REFERENCES characters(id)
|
|
||||||
)
|
|
||||||
''')
|
|
||||||
|
|
||||||
# Initialize essential config key
|
|
||||||
cursor.execute('INSERT INTO config VALUES ("last_seen_notif_id", 0)')
|
|
||||||
|
|
||||||
""" # Insert example characters into the database if they don't already exist
|
|
||||||
characters = [
|
|
||||||
('Murakami-san', 1, 0.35),
|
|
||||||
('Mastodon-kun', 2, 0.25),
|
|
||||||
('Pleroma-tan', 3, 0.2),
|
|
||||||
('Misskey-tan', 4, 0.15),
|
|
||||||
('Syuilo-mama', 5, 0.05)
|
|
||||||
]
|
|
||||||
|
|
||||||
|
|
||||||
cursor.executemany('''
|
|
||||||
INSERT OR IGNORE INTO characters (name, rarity, weight) VALUES (?, ?, ?)
|
|
||||||
''', characters)
|
|
||||||
"""
|
|
||||||
|
|
||||||
# Commit changes and close
|
|
||||||
conn.commit()
|
|
||||||
conn.close()
|
|
|
@ -1,3 +1,19 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
import subprocess
|
import subprocess
|
||||||
import os
|
import os
|
||||||
from watchdog.observers import Observer
|
from watchdog.observers import Observer
|
||||||
|
|
41
docs/index.md
Normal file
41
docs/index.md
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
# 🎲 Kemoverse Documentation
|
||||||
|
|
||||||
|
Welcome to the developer documentation for **Kemoverse**, a gacha trading card game in the Fediverse!
|
||||||
|
|
||||||
|
Features collectible cards, rarity-based pulls, and integration with Misskey.
|
||||||
|
|
||||||
|
Name comes from Kemonomimi and Fediverse.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 📁 Table of Contents
|
||||||
|
|
||||||
|
- [Installation](./install.md)
|
||||||
|
- [Game Design](./design.md)
|
||||||
|
- [Bot Architecture](./bot.md)
|
||||||
|
- [Database Structure](./database.md)
|
||||||
|
- [Card System](./cards.md)
|
||||||
|
- [Web UI](./web.md)
|
||||||
|
- [Theming and Assets](./theme.md)
|
||||||
|
- [Contributing](./contributing.md)
|
||||||
|
- [FAQ](./faq.md)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
100
docs/install.md
Normal file
100
docs/install.md
Normal file
|
@ -0,0 +1,100 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu, VD15 and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
|
||||||
|
## 🧪 Installation
|
||||||
|
|
||||||
|
### Download and install dependencies
|
||||||
|
|
||||||
|
Clone the repo
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://git.waifuism.life/waifu/kemoverse.git
|
||||||
|
cd kemoverse
|
||||||
|
```
|
||||||
|
|
||||||
|
Setup a virtual environment (Optional, recommended)
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 -m venv venv
|
||||||
|
source venv/bin/activate
|
||||||
|
```
|
||||||
|
|
||||||
|
Install project dependencies via pip
|
||||||
|
|
||||||
|
```sh
|
||||||
|
python3 -m pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setup config file
|
||||||
|
|
||||||
|
A sample config file is included with the project as a template: `example_config.ini`
|
||||||
|
|
||||||
|
Create a copy of this file and replace its' values with your own. Consult the
|
||||||
|
template for more information about individual config values and their meaning.
|
||||||
|
|
||||||
|
Config files are environment-specific. Use `config_dev.ini` for development and
|
||||||
|
`config_prod.ini` for production. Switch between environments using the
|
||||||
|
`KEMOVERSE_ENV` environment variable.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cp example_config.ini config_dev.ini
|
||||||
|
# Edit config_dev.ini
|
||||||
|
```
|
||||||
|
|
||||||
|
### Setup database
|
||||||
|
|
||||||
|
To set up the database, run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
KEMOVERSE_ENV=dev python3 setup_db.py
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run the bot
|
||||||
|
|
||||||
|
```sh
|
||||||
|
KEMOVERSE_ENV=dev ./startup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
If all goes well, you should now be able to interact with the bot.
|
||||||
|
|
||||||
|
### Running in production
|
||||||
|
|
||||||
|
To run the the in a production environment, use `KEMOVERSE_ENV=prod`. You will
|
||||||
|
also need to create a `config_prod.ini` file and run the database setup step
|
||||||
|
again if pointing prod to a different database. (you are pointing dev and prod
|
||||||
|
to different databases, right? 🤨)
|
||||||
|
|
||||||
|
### Updating
|
||||||
|
|
||||||
|
To update the bot, first pull new changes from upstream:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git pull
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run any database migrations. We recommend testing in dev beforehand to
|
||||||
|
make sure nothing breaks in the update process.
|
||||||
|
|
||||||
|
**Always backup your prod database before running any migrations!**
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Backup database file
|
||||||
|
cp gacha_game_dev.db gacha_game_dev.db.bak
|
||||||
|
# Run migrations
|
||||||
|
KEMOVERSE_ENV=dev python3 setup_db.py
|
||||||
|
```
|
50
docs/theme.md
Normal file
50
docs/theme.md
Normal file
|
@ -0,0 +1,50 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
Welcome to the **Visual Identity** guide for the Kemoverse. This page contains the standard colors, logos, and graphic elements used across the game (cards, UI, web presence, bots, etc). Please follow these guidelines to ensure consistency.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🟢 Primary Color Palette
|
||||||
|
|
||||||
|
| Color Name | Hex Code | Usage |
|
||||||
|
|----------------|------------|--------------------------------------|
|
||||||
|
| Green | `#5aa02c` | Main buttons, links, headers |
|
||||||
|
| Midnight Black | `#1A1A1A` | Backgrounds, dark mode |
|
||||||
|
| Misty White | `#FAFAFA` | Default backgrounds, light text bg |
|
||||||
|
| Soft Gray | `#CCCCCC` | Borders, placeholders, separators |
|
||||||
|
| Highlight Green | `#8dd35f` | Alerts, emphasis, icons |
|
||||||
|
| Rarity Gold | `#FFD700` | Special rare cards, SSR outlines |
|
||||||
|
| Rarity Silver | `#C0C0C0` | Rare card text, stat glow effects |
|
||||||
|
|
||||||
|
> ✅ Use `Green` and `Misty White` for the standard UI. Avoid mixing in extra palettes unless explicitly needed.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🖼 Logos
|
||||||
|
|
||||||
|
### Main Logo
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="../web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
- File: `web/static/logo.png`
|
||||||
|
- Usage: Website header, favicon, bot avatar, watermark
|
||||||
|
|
||||||
|
|
||||||
|
---
|
|
@ -1,14 +1,49 @@
|
||||||
|
; Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
; Copyright © 2025 Waifu and VD15
|
||||||
|
|
||||||
|
; This program is free software: you can redistribute it and/or modify
|
||||||
|
; it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
; You should have received a copy of the GNU Affero General Public License
|
||||||
|
; along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
|
||||||
; Rename me to config.ini and put your values in here
|
; Rename me to config.ini and put your values in here
|
||||||
[application]
|
[application]
|
||||||
; Comma separated list of fedi handles for any administrator users
|
; Comma separated list of fedi handles for any administrator users
|
||||||
; More can be added through the application
|
; More can be added through the application
|
||||||
DefaultAdmins = ['admin@example.tld']
|
DefaultAdmins = ["@localadmin", "@remoteadmin@example.tld"]
|
||||||
; SQLite Database location
|
; SQLite Database location
|
||||||
DatabaseLocation = ./gacha_game.db
|
DatabaseLocation = ./gacha_game.db
|
||||||
|
; Instance type - either "misskey" or "pleroma"
|
||||||
|
InstanceType = misskey
|
||||||
|
; Web server port (default: 5000)
|
||||||
|
WebPort = 5000
|
||||||
|
; Web server bind address (default: 127.0.0.1, set to 0.0.0.0 to listen on all interfaces)
|
||||||
|
BindAddress = 127.0.0.1
|
||||||
|
|
||||||
|
; Whether to lmit access to the bot via an instance whitelist
|
||||||
|
; The whitelist can be adjusted via the application
|
||||||
|
UseWhitelist = False
|
||||||
|
|
||||||
[gacha]
|
[gacha]
|
||||||
; Number of seconds players have to wait between rolls
|
; Number of seconds players have to wait between rolls
|
||||||
RollInterval = 72000
|
RollInterval = 72000
|
||||||
|
; Rarity drop weights (1 to 5 stars)
|
||||||
|
; Format: rarity=weight per line
|
||||||
|
; In order: common, uncommon, rare, epic and legendary (Example values below)
|
||||||
|
Rarity_1 = 0.7
|
||||||
|
Rarity_2 = 0.2
|
||||||
|
Rarity_3 = 0.08
|
||||||
|
Rarity_4 = 0.015
|
||||||
|
Rarity_5 = 0.005
|
||||||
|
|
||||||
[notification]
|
[notification]
|
||||||
; Number of seconds to sleep while awaiting new notifications
|
; Number of seconds to sleep while awaiting new notifications
|
||||||
|
@ -24,4 +59,3 @@ User = @bot@example.tld
|
||||||
; API key for the bot
|
; API key for the bot
|
||||||
; Generate one by going to Settings > API > Generate access token
|
; Generate one by going to Settings > API > Generate access token
|
||||||
Token = abcdefghijklmnopqrstuvwxyz012345
|
Token = abcdefghijklmnopqrstuvwxyz012345
|
||||||
|
|
||||||
|
|
45
migrations/0000_setup.sql
Normal file
45
migrations/0000_setup.sql
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 VD15 and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
CREATE TABLE IF NOT EXISTS users (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
username TEXT UNIQUE NOT NULL,
|
||||||
|
has_rolled BOOLEAN NOT NULL DEFAULT 0
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS characters (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
rarity INTEGER NOT NULL,
|
||||||
|
weight REAL NOT NULL,
|
||||||
|
file_id TEXT NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS pulls (
|
||||||
|
id INTEGER PRIMARY KEY AUTOINCREMENT,
|
||||||
|
user_id INTEGER,
|
||||||
|
character_id INTEGER,
|
||||||
|
timestamp DATETIME DEFAULT CURRENT_TIMESTAMP,
|
||||||
|
FOREIGN KEY (user_id) REFERENCES users(id),
|
||||||
|
FOREIGN KEY (character_id) REFERENCES characters(id)
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS config (
|
||||||
|
key TEXT PRIMARY KEY,
|
||||||
|
value TEXT
|
||||||
|
);
|
||||||
|
INSERT OR IGNORE INTO config VALUES ("schema_version", 0);
|
18
migrations/0001_fix_notif_id.sql
Normal file
18
migrations/0001_fix_notif_id.sql
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 VD15 and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
INSERT OR IGNORE INTO config VALUES ("last_seen_notif_id", 0);
|
19
migrations/0002_weigh_infer.sql
Normal file
19
migrations/0002_weigh_infer.sql
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
ALTER TABLE characters DROP COLUMN weight;
|
22
migrations/0003_rename_tables.sql
Normal file
22
migrations/0003_rename_tables.sql
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 VD15 and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
ALTER TABLE users RENAME TO players;
|
||||||
|
ALTER TABLE characters RENAME TO cards;
|
||||||
|
ALTER TABLE pulls RENAME user_id TO player_id;
|
||||||
|
ALTER TABLE pulls RENAME character_id TO card_id;
|
19
migrations/0004_add_administrators.sql
Normal file
19
migrations/0004_add_administrators.sql
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 VD15
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
ALTER TABLE players ADD COLUMN is_administrator BOOLEAN NOT NULL DEFAULT 0;
|
25
migrations/0005_add_whitelist.sql
Normal file
25
migrations/0005_add_whitelist.sql
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 VD15
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS instance_whitelist (
|
||||||
|
tld TEXT UNIQUE PRIMARY KEY
|
||||||
|
);
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS banned_players (
|
||||||
|
handle TEXT UNIQUE PRIMARY KEY
|
||||||
|
);
|
24
migrations/0006_card_stats.sql
Normal file
24
migrations/0006_card_stats.sql
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
|
||||||
|
CREATE TABLE IF NOT EXISTS card_stats (
|
||||||
|
card_id INTEGER PRIMARY KEY,
|
||||||
|
power INTEGER NOT NULL DEFAULT abs(random() % 9999),
|
||||||
|
charm INTEGER NOT NULL DEFAULT abs(random() % 9999),,
|
||||||
|
FOREIGN KEY(card_id) REFERENCES card(id)
|
||||||
|
)
|
129
readme.md
129
readme.md
|
@ -1,35 +1,120 @@
|
||||||
# Readme
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu and contributors.
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Kemoverse
|
||||||
|
|
||||||
|
A gacha-style bot for the Fediverse built with Python. Users can roll for characters, trade, duel, and perhaps engage with popularity-based mechanics. Supports both Misskey and Pleroma instances. Name comes from Kemonomimi and Fediverse.
|
||||||
|
<p align="center">
|
||||||
|
<img src="./web/static/logo.png" alt="Fediverse Gacha Bot Logo" width="300" height="auto">
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## 📝 Docs
|
||||||
|
|
||||||
|
👉 [**Start reading the docs**](./docs/index.md)
|
||||||
|
|
||||||
|
🤌 [**Install instructions for those in a rush**](docs/install.md)
|
||||||
|
|
||||||
|
## 🔧 Features
|
||||||
|
|
||||||
|
### ✅ Implemented
|
||||||
|
- 🎲 Character roll system
|
||||||
|
- 🧠 Core database structure for cards
|
||||||
|
- 📦 Basic support for storing pulls per player
|
||||||
|
- ⏱️ Time-based limitations on rolls
|
||||||
|
- ⚠️ Explicit account creation/deletion
|
||||||
|
|
||||||
|
### 🧩 In Progress
|
||||||
|
- 📝 Whitelist system to limit access
|
||||||
|
|
||||||
|
|
||||||
|
## 🧠 Roadmap
|
||||||
|
|
||||||
|
[See our v2.0 board for more details](https://git.waifuism.life/waifu/kemoverse/projects/3)
|
||||||
|
|
||||||
|
### 🛒 Gameplay & Collection
|
||||||
|
- 🔁 **Trading system** between players
|
||||||
|
- ⭐ **Favorite characters** (pin them or set profiles)
|
||||||
|
- 📢 **Public post announcements** for rare card pulls
|
||||||
|
- 📊 **Stats** for cards
|
||||||
|
- 🎮 **Games** to play
|
||||||
|
- ⚔️ Dueling
|
||||||
|
- 🧮 **Leaderboards**
|
||||||
|
- Most traded cards
|
||||||
|
- Most owned cards
|
||||||
|
- Most voted cards
|
||||||
|
- Most popular cards (via usage-based popularity metrics)
|
||||||
|
- Users with the rarest cards
|
||||||
|
|
||||||
|
### 🎨 Card Aesthetics
|
||||||
|
- 🖼️ Simple card template for character rendering
|
||||||
|
- 🌐 Web app to generate cards from images
|
||||||
|
|
||||||
|
### 🌍 Fediverse Support
|
||||||
|
✅ Anyone from the fediverse can play! The bot supports both Misskey and Pleroma instances through configurable backends.
|
||||||
|
|
||||||
|
## 🗃️ Tech Stack
|
||||||
|
|
||||||
|
- Python (3.12+)
|
||||||
|
- SQLite
|
||||||
|
- Fediverse API integration (Misskey and Pleroma support)
|
||||||
|
- Flask
|
||||||
|
- Modular DB design for extensibility
|
||||||
|
|
||||||
|
## 💡 Philosophy
|
||||||
|
|
||||||
|
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
|
||||||
|
|
||||||
|
## 📝 License
|
||||||
|
|
||||||
|
Unless stated otherwise, this repository is:
|
||||||
|
|
||||||
|
**Copyright © 2025 Waifu and contributors**
|
||||||
|
**Licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🛠️ What this means for you:
|
||||||
|
|
||||||
|
- You are free to **use**, **modify**, and **redistribute** the code, as long as you preserve the same license.
|
||||||
|
- If you run a modified version of this software as part of a service (e.g., a website or bot), you must also **share the source code** of your modifications with users.
|
||||||
|
|
||||||
|
A copy of the license should also be included in this repository.
|
||||||
|
If not, you can always find it at [gnu.org/licenses](https://www.gnu.org/licenses/).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
The AGPL exists to **protect user freedom**, especially in networked and server-side software. If you enhance or build upon this project, please help the community by sharing your changes too.
|
||||||
|
|
||||||
|
Unless explicitly stated otherwise, **all files in this repository are covered by the AGPL v3.0 or any later version**.
|
||||||
|
|
||||||
To-do:
|
|
||||||
- Whitelist system for users
|
|
||||||
- Time limitation on rolls
|
|
||||||
|
|
||||||
Long term:
|
|
||||||
- Trading
|
|
||||||
- Card burning
|
|
||||||
- Favorite characters
|
|
||||||
- Public post for rare cards
|
|
||||||
- Leaderboards
|
|
||||||
- Most traded Characters
|
|
||||||
- Most owned Characters
|
|
||||||
- Most voted Characters
|
|
||||||
- Most popular Characters
|
|
||||||
- Users with the rarest Characters
|
|
||||||
- Simple card template
|
|
||||||
- Website to place images in the card
|
|
||||||
- Add Pleroma support
|
|
||||||
|
|
||||||
|
|
||||||
```mermaid
|
```mermaid
|
||||||
flowchart TD
|
flowchart TD
|
||||||
|
|
||||||
subgraph Player Interaction
|
subgraph Player Interaction
|
||||||
A1[Misskey bot]
|
A1[Fediverse bot]
|
||||||
A2[Web]
|
A2[Web]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph Misskey
|
subgraph Fediverse
|
||||||
B1[Misskey instance]
|
B1[Fediverse instance]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph Bot
|
subgraph Bot
|
||||||
|
@ -37,7 +122,7 @@ flowchart TD
|
||||||
C2[Notification parser]
|
C2[Notification parser]
|
||||||
C3[Gacha roll logic]
|
C3[Gacha roll logic]
|
||||||
C4[Database interface]
|
C4[Database interface]
|
||||||
C5[Misskey API poster]
|
C5[Fediverse API poster]
|
||||||
end
|
end
|
||||||
|
|
||||||
subgraph Website
|
subgraph Website
|
||||||
|
|
|
@ -1,3 +1,19 @@
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
blinker==1.9.0
|
blinker==1.9.0
|
||||||
click==8.1.8
|
click==8.1.8
|
||||||
Flask==3.1.0
|
Flask==3.1.0
|
||||||
|
@ -6,3 +22,5 @@ Jinja2==3.1.6
|
||||||
MarkupSafe==3.0.2
|
MarkupSafe==3.0.2
|
||||||
Werkzeug==3.1.3
|
Werkzeug==3.1.3
|
||||||
Misskey.py==4.1.0
|
Misskey.py==4.1.0
|
||||||
|
Mastodon.py==1.8.1
|
||||||
|
filetype==1.2.0
|
||||||
|
|
142
setup_db.py
Normal file
142
setup_db.py
Normal file
|
@ -0,0 +1,142 @@
|
||||||
|
#Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
#Copyright © 2025 Waifu
|
||||||
|
#
|
||||||
|
#This program is free software: you can redistribute it and/or modify
|
||||||
|
#it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
#You should have received a copy of the GNU Affero General Public License
|
||||||
|
#along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
import traceback
|
||||||
|
import os
|
||||||
|
import argparse
|
||||||
|
from configparser import ConfigParser
|
||||||
|
from typing import List, Tuple
|
||||||
|
|
||||||
|
class DBNotFoundError(Exception):
|
||||||
|
'''Could not find the database location'''
|
||||||
|
|
||||||
|
class InvalidMigrationError(Exception):
|
||||||
|
'''Migration file has an invalid name'''
|
||||||
|
|
||||||
|
class KemoverseEnvUnset(Exception):
|
||||||
|
'''KEMOVERSE_ENV is not set or has an invalid value'''
|
||||||
|
|
||||||
|
class ConfigError(Exception):
|
||||||
|
'''Could not find the config file for the current environment'''
|
||||||
|
|
||||||
|
def get_migrations() -> List[Tuple[int, str]] | InvalidMigrationError:
|
||||||
|
'''Returns a list of migration files in numeric order.'''
|
||||||
|
# Store transaction id and filename separately
|
||||||
|
sql_files: List[Tuple[int, str]] = []
|
||||||
|
migrations_dir = 'migrations'
|
||||||
|
|
||||||
|
for filename in os.listdir(migrations_dir):
|
||||||
|
joined_path = os.path.join(migrations_dir, filename)
|
||||||
|
|
||||||
|
# Ignore anything that isn't a .sql file
|
||||||
|
if not (os.path.isfile(joined_path) and filename.endswith('.sql')):
|
||||||
|
print(f'{filename} is not a .sql file, ignoring...')
|
||||||
|
continue
|
||||||
|
|
||||||
|
parts = filename.split('_', 1)
|
||||||
|
|
||||||
|
# Invalid filename format
|
||||||
|
if len(parts) < 2 or not parts[0].isdigit():
|
||||||
|
raise InvalidMigrationError(f'Invalid migration file: {filename}')
|
||||||
|
|
||||||
|
sql_files.append((int(parts[0]), joined_path))
|
||||||
|
|
||||||
|
# Get sorted list of files by migration number
|
||||||
|
sql_files.sort(key=lambda x: x[0])
|
||||||
|
return sql_files
|
||||||
|
|
||||||
|
def perform_migration(cursor: sqlite3.Cursor, migration: tuple[int, str]) -> None:
|
||||||
|
'''Performs a migration on the DB'''
|
||||||
|
print(f'Performing migration {migration[1]}...')
|
||||||
|
|
||||||
|
# Open and execute the sql script
|
||||||
|
with open(migration[1], encoding='utf-8') as file:
|
||||||
|
script = file.read()
|
||||||
|
cursor.executescript(script)
|
||||||
|
# Update the schema version
|
||||||
|
cursor.execute('UPDATE config SET value = ? WHERE key = "schema_version"', (migration[0],))
|
||||||
|
|
||||||
|
def get_db_path() -> str | DBNotFoundError:
|
||||||
|
'''Gets the DB path from config.ini'''
|
||||||
|
env = os.environ.get('KEMOVERSE_ENV')
|
||||||
|
|
||||||
|
config_path = f'config_{env}.ini'
|
||||||
|
|
||||||
|
if not os.path.isfile(config_path):
|
||||||
|
raise ConfigError(f'Could not find {config_path}')
|
||||||
|
|
||||||
|
print(f'Running in "{env}" mode')
|
||||||
|
|
||||||
|
config = ConfigParser()
|
||||||
|
config.read(config_path)
|
||||||
|
db_path = config['application']['DatabaseLocation']
|
||||||
|
if not db_path:
|
||||||
|
raise DBNotFoundError()
|
||||||
|
return db_path
|
||||||
|
|
||||||
|
def get_current_migration(cursor: sqlite3.Cursor) -> int:
|
||||||
|
'''Gets the current schema version of the database'''
|
||||||
|
try:
|
||||||
|
cursor.execute('SELECT value FROM config WHERE key = ?', ('schema_version',))
|
||||||
|
version = cursor.fetchone()
|
||||||
|
return -1 if not version else int(version[0])
|
||||||
|
except sqlite3.Error:
|
||||||
|
print('Error getting schema version')
|
||||||
|
# Database has not been initialized yet
|
||||||
|
return -1
|
||||||
|
|
||||||
|
def main():
|
||||||
|
'''Does the thing'''
|
||||||
|
# Connect to the DB
|
||||||
|
db_path = ''
|
||||||
|
try:
|
||||||
|
db_path = get_db_path()
|
||||||
|
except ConfigError as ex:
|
||||||
|
print(ex)
|
||||||
|
return
|
||||||
|
except KemoverseEnvUnset:
|
||||||
|
print('Error: KEMOVERSE_ENV is either not set or has an invalid value.')
|
||||||
|
print(traceback.format_exc())
|
||||||
|
return
|
||||||
|
|
||||||
|
conn = sqlite3.connect(db_path, autocommit=False)
|
||||||
|
conn.row_factory = sqlite3.Row
|
||||||
|
cursor = conn.cursor()
|
||||||
|
|
||||||
|
# Obtain list of migrations to run
|
||||||
|
migrations = get_migrations()
|
||||||
|
# Determine schema version
|
||||||
|
current_migration = get_current_migration(cursor)
|
||||||
|
print(f'Current schema version: {current_migration}')
|
||||||
|
|
||||||
|
# Run any migrations newer than current schema
|
||||||
|
for migration in migrations:
|
||||||
|
if migration[0] <= current_migration:
|
||||||
|
print(f'Migration already up: {migration[1]}')
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
perform_migration(cursor, migration)
|
||||||
|
conn.commit()
|
||||||
|
except Exception as ex:
|
||||||
|
print(f'An error occurred while applying {migration[1]}: {ex}, aborting...')
|
||||||
|
print(traceback.format_exc())
|
||||||
|
conn.rollback()
|
||||||
|
break
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
16
startup.sh
16
startup.sh
|
@ -1,5 +1,21 @@
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
# Copyright © 2025 Waifu and VD15
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
# Navigate to the project directory (optional)
|
# Navigate to the project directory (optional)
|
||||||
cd "$(dirname "$0")"
|
cd "$(dirname "$0")"
|
||||||
|
|
||||||
|
|
41
web/app.py
41
web/app.py
|
@ -1,14 +1,45 @@
|
||||||
from flask import Flask, render_template
|
#Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
#Copyright © 2025 Waifu
|
||||||
|
#
|
||||||
|
#This program is free software: you can redistribute it and/or modify
|
||||||
|
#it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
#
|
||||||
|
#You should have received a copy of the GNU Affero General Public License
|
||||||
|
#along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
|
||||||
import sqlite3
|
import sqlite3
|
||||||
|
import sys
|
||||||
|
import os
|
||||||
|
|
||||||
|
# Add bot directory to path to import config
|
||||||
|
sys.path.append(os.path.join(os.path.dirname(__file__), '..', 'bot'))
|
||||||
|
import config
|
||||||
|
|
||||||
|
from flask import Flask, render_template, abort
|
||||||
|
from werkzeug.exceptions import HTTPException
|
||||||
|
|
||||||
app = Flask(__name__)
|
app = Flask(__name__)
|
||||||
DB_PATH = "./gacha_game.db" # Adjust path if needed
|
|
||||||
|
|
||||||
def get_db_connection():
|
def get_db_connection():
|
||||||
conn = sqlite3.connect(DB_PATH)
|
conn = sqlite3.connect(config.DB_PATH)
|
||||||
conn.row_factory = sqlite3.Row
|
conn.row_factory = sqlite3.Row
|
||||||
return conn
|
return conn
|
||||||
|
|
||||||
|
@app.errorhandler(HTTPException)
|
||||||
|
def handle_exception(error):
|
||||||
|
return render_template("_error.html", error=error), error.code
|
||||||
|
|
||||||
|
@app.route("/i404")
|
||||||
|
def i404():
|
||||||
|
return abort(404)
|
||||||
|
|
||||||
@app.route('/')
|
@app.route('/')
|
||||||
def index():
|
def index():
|
||||||
conn = get_db_connection()
|
conn = get_db_connection()
|
||||||
|
@ -33,6 +64,8 @@ def user_profile(user_id):
|
||||||
|
|
||||||
cursor.execute('SELECT * FROM users WHERE id = ?', (user_id,))
|
cursor.execute('SELECT * FROM users WHERE id = ?', (user_id,))
|
||||||
user = cursor.fetchone()
|
user = cursor.fetchone()
|
||||||
|
if user is None:
|
||||||
|
abort(404)
|
||||||
|
|
||||||
cursor.execute('''
|
cursor.execute('''
|
||||||
SELECT pulls.timestamp, characters.name as character_name, characters.rarity
|
SELECT pulls.timestamp, characters.name as character_name, characters.rarity
|
||||||
|
@ -56,4 +89,4 @@ def submit_character():
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
app.run(host='0.0.0.0', port=5000, debug=True)
|
app.run(host=config.BIND_ADDRESS, port=config.WEB_PORT, debug=True)
|
||||||
|
|
BIN
web/static/logo.png
Normal file
BIN
web/static/logo.png
Normal file
Binary file not shown.
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
109
web/static/style.css
Normal file
109
web/static/style.css
Normal file
|
@ -0,0 +1,109 @@
|
||||||
|
/*
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
*/
|
||||||
|
body {
|
||||||
|
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
|
||||||
|
background-color: #FAFAFA;
|
||||||
|
color: #333;
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
header {
|
||||||
|
background-color: #5aa02c;
|
||||||
|
color: white;
|
||||||
|
padding: 20px;
|
||||||
|
text-align: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
header h1 {
|
||||||
|
margin: 0;
|
||||||
|
font-size: 2.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
header p {
|
||||||
|
margin-top: 5px;
|
||||||
|
font-size: 1.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.container {
|
||||||
|
max-width: 800px;
|
||||||
|
margin: 30px auto;
|
||||||
|
padding: 20px;
|
||||||
|
background-color: #ffffff;
|
||||||
|
border-radius: 10px;
|
||||||
|
box-shadow: 0 3px 10px rgba(0, 0, 0, 0.07);
|
||||||
|
}
|
||||||
|
|
||||||
|
h2 {
|
||||||
|
border-bottom: 1px solid #ccc;
|
||||||
|
padding-bottom: 8px;
|
||||||
|
margin-top: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul {
|
||||||
|
list-style-type: none;
|
||||||
|
padding-left: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
li {
|
||||||
|
margin: 10px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
a {
|
||||||
|
text-decoration: none;
|
||||||
|
color: #2c3e50;
|
||||||
|
font-weight: bold;
|
||||||
|
background-color: #e3eaf3;
|
||||||
|
padding: 8px 12px;
|
||||||
|
border-radius: 6px;
|
||||||
|
display: inline-block;
|
||||||
|
transition: background-color 0.2s;
|
||||||
|
}
|
||||||
|
|
||||||
|
a:hover {
|
||||||
|
background-color: #cdd8e6;
|
||||||
|
}
|
||||||
|
|
||||||
|
.leaderboard-entry {
|
||||||
|
margin-bottom: 8px;
|
||||||
|
padding: 6px 10px;
|
||||||
|
background: #f9fafc;
|
||||||
|
border-left: 4px solid #7289da;
|
||||||
|
border-radius: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
footer {
|
||||||
|
text-align: center;
|
||||||
|
margin-top: 40px;
|
||||||
|
font-size: 0.9em;
|
||||||
|
color: #888;
|
||||||
|
}
|
||||||
|
|
||||||
|
.note {
|
||||||
|
background: #fcfcf0;
|
||||||
|
border: 1px dashed #bbb;
|
||||||
|
padding: 10px;
|
||||||
|
border-radius: 8px;
|
||||||
|
margin-top: 30px;
|
||||||
|
font-size: 0.95em;
|
||||||
|
color: #666;
|
||||||
|
}
|
||||||
|
|
||||||
|
.footer-link {
|
||||||
|
margin: 0 10px;
|
||||||
|
}
|
47
web/templates/_base.html
Normal file
47
web/templates/_base.html
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<html>
|
||||||
|
<head>
|
||||||
|
<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='style.css') }}">
|
||||||
|
<link rel="shortcut icon" href="{{ url_for('static', filename='logo.png') }}">
|
||||||
|
<title>
|
||||||
|
{% if title %}
|
||||||
|
{{ title }}
|
||||||
|
{% else %}
|
||||||
|
{% block title %}{% endblock %}
|
||||||
|
{% endif %}
|
||||||
|
| Kemoverse
|
||||||
|
</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<header>
|
||||||
|
{% block header %}{% endblock %}
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div class="container">
|
||||||
|
{% block content %}{% endblock %}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<footer>
|
||||||
|
<a class="footer-link" href="{{ url_for('about') }}">About</a>
|
||||||
|
<a class="footer-link" href="{{ url_for('submit_character') }}">Submit a Character</a>
|
||||||
|
{% block footer_extra %}{% endblock %}
|
||||||
|
</footer>
|
||||||
|
</body>
|
||||||
|
</html>
|
25
web/templates/_error.html
Normal file
25
web/templates/_error.html
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
<!--
|
||||||
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
|
Copyright © 2025 Waifu
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
{% extends "_base.html" %}
|
||||||
|
{% block title %}
|
||||||
|
{{ error.code }}
|
||||||
|
{% endblock %}
|
||||||
|
{% block content %}
|
||||||
|
<h2>{{ error.code }} - {{ error.name }} </h2>
|
||||||
|
<p>{{ error.description }}</p>
|
||||||
|
{% endblock %}
|
|
@ -1,13 +1,26 @@
|
||||||
<!DOCTYPE html>
|
<!--
|
||||||
<html>
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
<head>
|
Copyright © 2025 Waifu
|
||||||
<title>About - Misskey Gacha Center</title>
|
|
||||||
</head>
|
This program is free software: you can redistribute it and/or modify
|
||||||
<body>
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
{% extends "_base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
<h1>About This Gacha</h1>
|
<h1>About This Gacha</h1>
|
||||||
<p>This is a playful Misskey-themed gacha tracker made with Flask and SQLite.</p>
|
<p>This is a playful Misskey-themed gacha tracker made with Flask and SQLite.</p>
|
||||||
<p>All rolls are stored, stats are tracked, and characters are added manually for now.</p>
|
<p>All rolls are stored, stats are tracked, and characters are added manually for now.</p>
|
||||||
<p>Built with love, chaos, and way too much caffeine ☕.</p>
|
<p>Built with love, chaos, and way too much caffeine ☕.</p>
|
||||||
<a href="{{ url_for('index') }}">← Back to Home</a>
|
<a href="{{ url_for('index') }}">← Back to Home</a>
|
||||||
</body>
|
{% endblock %}
|
||||||
</html>
|
|
|
@ -1,110 +1,29 @@
|
||||||
<!DOCTYPE html>
|
<!--
|
||||||
<html>
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
<head>
|
Copyright © 2025 Waifu
|
||||||
<title>Misskey Gacha Center</title>
|
|
||||||
<style>
|
|
||||||
body {
|
|
||||||
font-family: "Segoe UI", Tahoma, Geneva, Verdana, sans-serif;
|
|
||||||
background-color: #f4f6fa;
|
|
||||||
color: #333;
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
header {
|
This program is free software: you can redistribute it and/or modify
|
||||||
background-color: #7289da;
|
it under the terms of the GNU Affero General Public License as
|
||||||
color: white;
|
published by the Free Software Foundation, either version 3 of the
|
||||||
padding: 20px;
|
License, or (at your option) any later version.
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
header h1 {
|
This program is distributed in the hope that it will be useful,
|
||||||
margin: 0;
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
font-size: 2.5em;
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
}
|
GNU Affero General Public License for more details.
|
||||||
|
|
||||||
header p {
|
You should have received a copy of the GNU Affero General Public License
|
||||||
margin-top: 5px;
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
font-size: 1.1em;
|
-->
|
||||||
}
|
|
||||||
|
|
||||||
.container {
|
{% extends "_base.html" %}
|
||||||
max-width: 800px;
|
|
||||||
margin: 30px auto;
|
|
||||||
padding: 20px;
|
|
||||||
background-color: #ffffff;
|
|
||||||
border-radius: 10px;
|
|
||||||
box-shadow: 0 3px 10px rgba(0, 0, 0, 0.07);
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
{% block header %}
|
||||||
border-bottom: 1px solid #ccc;
|
|
||||||
padding-bottom: 8px;
|
|
||||||
margin-top: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul {
|
|
||||||
list-style-type: none;
|
|
||||||
padding-left: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
margin: 10px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
text-decoration: none;
|
|
||||||
color: #2c3e50;
|
|
||||||
font-weight: bold;
|
|
||||||
background-color: #e3eaf3;
|
|
||||||
padding: 8px 12px;
|
|
||||||
border-radius: 6px;
|
|
||||||
display: inline-block;
|
|
||||||
transition: background-color 0.2s;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover {
|
|
||||||
background-color: #cdd8e6;
|
|
||||||
}
|
|
||||||
|
|
||||||
.leaderboard-entry {
|
|
||||||
margin-bottom: 8px;
|
|
||||||
padding: 6px 10px;
|
|
||||||
background: #f9fafc;
|
|
||||||
border-left: 4px solid #7289da;
|
|
||||||
border-radius: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
footer {
|
|
||||||
text-align: center;
|
|
||||||
margin-top: 40px;
|
|
||||||
font-size: 0.9em;
|
|
||||||
color: #888;
|
|
||||||
}
|
|
||||||
|
|
||||||
.note {
|
|
||||||
background: #fcfcf0;
|
|
||||||
border: 1px dashed #bbb;
|
|
||||||
padding: 10px;
|
|
||||||
border-radius: 8px;
|
|
||||||
margin-top: 30px;
|
|
||||||
font-size: 0.95em;
|
|
||||||
color: #666;
|
|
||||||
}
|
|
||||||
|
|
||||||
.footer-link {
|
|
||||||
margin: 0 10px;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
<header>
|
|
||||||
<h1>Misskey Gacha Center</h1>
|
<h1>Misskey Gacha Center</h1>
|
||||||
<p>Track your luck. Compare your pulls. Compete with friends.</p>
|
<p>Track your luck. Compare your pulls. Compete with friends.</p>
|
||||||
</header>
|
{% endblock %}
|
||||||
|
|
||||||
<div class="container">
|
{% block content %}
|
||||||
|
|
||||||
<h2>🎖️ Leaderboard: Most Rolls</h2>
|
<h2>🎖️ Leaderboard: Most Rolls</h2>
|
||||||
{% for user in top_users %}
|
{% for user in top_users %}
|
||||||
|
@ -125,13 +44,4 @@
|
||||||
<div class="note">
|
<div class="note">
|
||||||
🚀 This is a fun little gacha tracker! More features coming soon. Want to help shape it?
|
🚀 This is a fun little gacha tracker! More features coming soon. Want to help shape it?
|
||||||
</div>
|
</div>
|
||||||
|
{% endblock %}
|
||||||
</div>
|
|
||||||
|
|
||||||
<footer>
|
|
||||||
<a class="footer-link" href="{{ url_for('about') }}">About</a>
|
|
||||||
<a class="footer-link" href="{{ url_for('submit_character') }}">Submit a Character</a>
|
|
||||||
</footer>
|
|
||||||
|
|
||||||
</body>
|
|
||||||
</html>
|
|
|
@ -1,12 +1,25 @@
|
||||||
<!DOCTYPE html>
|
<!--
|
||||||
<html>
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
<head>
|
Copyright © 2025 Waifu
|
||||||
<title>Submit a Character - Misskey Gacha Center</title>
|
|
||||||
</head>
|
This program is free software: you can redistribute it and/or modify
|
||||||
<body>
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
{% extends "_base.html" %}
|
||||||
|
|
||||||
|
{% block content %}
|
||||||
<h1>Submit a Character</h1>
|
<h1>Submit a Character</h1>
|
||||||
<p>Want to add a new character to the gacha pool?</p>
|
<p>Want to add a new character to the gacha pool?</p>
|
||||||
<p>This feature will be available soon. Stay tuned!</p>
|
<p>This feature will be available soon. Stay tuned!</p>
|
||||||
<a href="{{ url_for('index') }}">← Back to Home</a>
|
<a href="{{ url_for('index') }}">← Back to Home</a>
|
||||||
</body>
|
{% endblock %}
|
||||||
</html>
|
|
|
@ -1,57 +1,22 @@
|
||||||
<!DOCTYPE html>
|
<!--
|
||||||
<html>
|
Kemoverse - a gacha-style bot for the Fediverse.
|
||||||
<head>
|
Copyright © 2025 Waifu
|
||||||
<title>{{ user['username'] }}'s Rolls</title>
|
|
||||||
<style>
|
|
||||||
body {
|
|
||||||
font-family: Arial, sans-serif;
|
|
||||||
background-color: #f4f4f8;
|
|
||||||
margin: 0;
|
|
||||||
padding: 20px;
|
|
||||||
}
|
|
||||||
.profile, .pulls {
|
|
||||||
background-color: white;
|
|
||||||
padding: 15px;
|
|
||||||
border-radius: 10px;
|
|
||||||
box-shadow: 0 0 10px rgba(0,0,0,0.1);
|
|
||||||
margin-bottom: 20px;
|
|
||||||
}
|
|
||||||
h1, h2 {
|
|
||||||
margin-top: 0;
|
|
||||||
}
|
|
||||||
ul {
|
|
||||||
list-style-type: none;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
li {
|
|
||||||
padding: 10px 0;
|
|
||||||
border-bottom: 1px solid #eee;
|
|
||||||
}
|
|
||||||
.rarity {
|
|
||||||
color: gold;
|
|
||||||
font-weight: bold;
|
|
||||||
margin-left: 8px;
|
|
||||||
}
|
|
||||||
.timestamp {
|
|
||||||
color: #888;
|
|
||||||
font-size: 0.9em;
|
|
||||||
}
|
|
||||||
a {
|
|
||||||
display: inline-block;
|
|
||||||
margin-top: 20px;
|
|
||||||
color: #333;
|
|
||||||
text-decoration: none;
|
|
||||||
background-color: #ddd;
|
|
||||||
padding: 8px 12px;
|
|
||||||
border-radius: 5px;
|
|
||||||
}
|
|
||||||
a:hover {
|
|
||||||
background-color: #bbb;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU Affero General Public License
|
||||||
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
||||||
|
-->
|
||||||
|
{% extends "_base.html" %}
|
||||||
|
{% block content %}
|
||||||
<div class="profile">
|
<div class="profile">
|
||||||
<h1>{{ user['username'] }}'s Gacha Rolls</h1>
|
<h1>{{ user['username'] }}'s Gacha Rolls</h1>
|
||||||
<p>User ID: {{ user['id'] }}</p>
|
<p>User ID: {{ user['id'] }}</p>
|
||||||
|
@ -72,6 +37,4 @@
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<a href="{{ url_for('index') }}">← Back to Users</a>
|
<a href="{{ url_for('index') }}">← Back to Users</a>
|
||||||
|
{% endblock %}
|
||||||
</body>
|
|
||||||
</html>
|
|
Loading…
Add table
Reference in a new issue