diff --git a/.gitignore b/.gitignore
index e5543ec..2ccf20c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -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
__pycache__/
*.py[cod]
@@ -185,5 +201,6 @@ cython_debug/
gacha_game*.db
gacha_game*.db.*
config*.ini
+run.sh
-.idea
\ No newline at end of file
+.idea
diff --git a/.tool-versions b/.tool-versions
new file mode 100644
index 0000000..45e4b9f
--- /dev/null
+++ b/.tool-versions
@@ -0,0 +1 @@
+nodejs 23.4.0
diff --git a/LICENSE b/LICENSE
index f288702..c6f01c6 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,200 +1,192 @@
- GNU GENERAL PUBLIC LICENSE
- Version 3, 29 June 2007
+# GNU AFFERO GENERAL PUBLIC LICENSE
- Copyright (C) 2007 Free Software Foundation, Inc.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
+Version 3, 19 November 2007
- Preamble
+Copyright (C) 2007 Free Software Foundation, Inc.
+
- The GNU General Public License is a free, copyleft license for
-software and other kinds of works.
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
- The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-the GNU General Public License is intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains free
-software for all its users. We, the Free Software Foundation, use the
-GNU General Public License for most of our software; it applies also to
-any other work released this way by its authors. You can apply it to
-your programs, too.
+## Preamble
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
+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
+to take away your freedom to share and change the works. By contrast,
+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 software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
- To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights. Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received. You must make sure that they, too, receive
-or can get the source code. And you must show them these terms so they
-know their rights.
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+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:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+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
-that there is no warranty for this free software. For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing
+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.
- 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
-works, such as semiconductor masks.
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
- "The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
- To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy. The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
- A "covered work" means either the unmodified Program or a work based
+A "covered work" means either the unmodified Program or a work based
on the Program.
- To "propagate" a work means to do anything with it that, without
+To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
+computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
- To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
- An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
+work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
- 1. Source Code.
+### 1. Source Code.
- The "source code" for a work means the preferred form of the work
-for making modifications to it. "Object code" means any non-source
-form of a work.
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
- A "Standard Interface" means an interface that either is an official
+A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
- The "System Libraries" of an executable work include anything, other
+The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
+implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
- The "Corresponding Source" for a work in object code form means all
+The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
+control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
+which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
- The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
- The Corresponding Source for a work in source code form is that
-same work.
+The Corresponding Source for a work in source code form is that same
+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
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
+content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
- You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force. You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright. Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
- Conveying under any other circumstances is permitted solely under
-the conditions stated below. Sublicensing is not allowed; section 10
-makes it unnecessary.
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+### 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
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
- When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
- 4. Conveying Verbatim Copies.
+### 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
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
@@ -202,59 +194,56 @@ non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
- You may charge any price or no price for each copy that you convey,
+You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
- 5. Conveying Modified Source Versions.
+### 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
-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.
-
- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under section
- 7. This requirement modifies the requirement in section 4 to
- "keep intact all notices".
-
- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
+- b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under
+ section 7. This requirement modifies the requirement in section 4
+ to "keep intact all notices".
+- c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
+ regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
-
- d) If the work has interactive user interfaces, each must display
+- d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
- A compilation of a covered work with other separate and independent
+A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
+beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
- 6. Conveying Non-Source Forms.
+### 6. Conveying Non-Source Forms.
- You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
- a) Convey the object code in, or embodied in, a physical product
+- a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
-
- b) Convey the object code in, or embodied in, a physical product
+- b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
@@ -263,196 +252,190 @@ in one of these ways:
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the
- Corresponding Source from a network server at no charge.
-
- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
+ conveying of source, or (2) access to copy the Corresponding
+ Source from a network server at no charge.
+- c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
-
- d) Convey the object code by offering access from a designated
+- d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
+ Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
+- e) Convey the object code using peer-to-peer transmission,
+ provided you inform other peers where the object code and
+ Corresponding Source of the work are being offered to the general
+ public at no charge under subsection 6d.
- e) Convey the object code using peer-to-peer transmission, provided
- you inform other peers where the object code and Corresponding
- Source of the work are being offered to the general public at no
- charge under subsection 6d.
-
- A separable portion of the object code, whose source code is excluded
+A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
- A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling. In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage. For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product. A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
- "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source. The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
- If you convey an object code work under this section in, or with, or
+If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
+by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
- The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed. Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
- Corresponding Source conveyed, and Installation Information provided,
+Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
- 7. Additional Terms.
+### 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.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
+that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
- When you convey a copy of a covered work, you may at your option
+When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
- Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
- a) Disclaiming warranty or limiting liability differently from the
+- a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
-
- b) Requiring preservation of specified reasonable legal notices or
+- b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
-
- c) Prohibiting misrepresentation of the origin of that material, or
- requiring that modified versions of such material be marked in
+- c) Prohibiting misrepresentation of the origin of that material,
+ or requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
-
- d) Limiting the use for publicity purposes of names of licensors or
- authors of the material; or
-
- e) Declining to grant rights under trademark law for use of some
+- d) Limiting the use for publicity purposes of names of licensors
+ or authors of the material; or
+- e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
+- f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions
+ of it) with contractual assumptions of liability to the recipient,
+ for any liability that these contractual assumptions directly
+ impose on those licensors and authors.
- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions of
- it) with contractual assumptions of liability to the recipient, for
- any liability that these contractual assumptions directly impose on
- those licensors and authors.
-
- All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
+restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
- If you add terms to a covered work in accord with this section, you
+If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
- Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
- 8. Termination.
+### 8. Termination.
- You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
- However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
- Moreover, your license from a particular copyright holder is
+Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
- Termination of your rights under this section does not terminate the
+Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
+this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
- 9. Acceptance Not Required for Having Copies.
+### 9. Acceptance Not Required for Having Copies.
- You are not required to accept this License in order to receive or
-run a copy of the Program. Ancillary propagation of a covered work
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
+to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
- 10. Automatic Licensing of Downstream Recipients.
+### 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
-propagate that work, subject to this License. You are not responsible
+propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
- An "entity transaction" is a transaction transferring control of an
+An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
+organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
@@ -460,43 +443,43 @@ give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
- You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
- 11. Patents.
+### 11. Patents.
- A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
- A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
+consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
- Each contributor grants you a non-exclusive, worldwide, royalty-free
+Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
- In the following three paragraphs, a "patent license" is any express
+In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
+sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
- If you convey a covered work, knowingly relying on a patent license,
+If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
@@ -504,13 +487,13 @@ then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
+license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
- If, pursuant to or in connection with a single transaction or
+If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
@@ -518,157 +501,160 @@ or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
- A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License. You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
- Nothing in this License shall be construed as excluding or limiting
+Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
- 12. No Surrender of Others' Freedom.
+### 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
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all. For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
- 13. Use with the GNU Affero General Public License.
+### 13. Remote Network Interaction; Use with the GNU General Public License.
- Notwithstanding any other provision of this License, you have
+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
permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work. The terms of this
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
- 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 GNU General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Affero General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
- Each version is given a distinguishing version number. If the
-Program specifies that a certain numbered version of the GNU General
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever
+published by the Free Software Foundation.
- If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
+If the Program specifies that a proxy can decide which future versions
+of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
- Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
- 15. Disclaimer of Warranty.
+### 15. Disclaimer of Warranty.
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
- 16. Limitation of Liability.
+### 16. Limitation of Liability.
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- 17. Interpretation of Sections 15 and 16.
+### 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,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
- END OF TERMS AND CONDITIONS
+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
-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 attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
-
- Copyright (C)
+
+ Copyright (C)
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
+ This program is 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 General Public License for more details.
+ 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 General Public License
- along with this program. If not, see .
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see .
-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
-notice like this when it starts in an interactive mode:
+If your software can interact with users remotely through a computer
+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.
- Copyright (C)
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
- You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-.
-
- 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
-.
+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 AGPL, see .
diff --git a/bot/add_card.py b/bot/add_card.py
new file mode 100644
index 0000000..a914b2e
--- /dev/null
+++ b/bot/add_card.py
@@ -0,0 +1,82 @@
+# 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, power: int, charm: int, wit: int) -> 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.
+ power (int): Card power value.
+ charm (int): Card charm value.
+ wit (int): Card wit value.
+
+ 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.')
+ if power < 0 or charm < 0 or wit < 0:
+ raise ValueError('Power, charm, and wit must be non-negative integers.')
+ 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,
+ power,
+ charm,
+ wit
+ )
+
+ return card_id, file_id
+
+ except Exception as e:
+ raise
diff --git a/bot/add_character.py b/bot/add_character.py
deleted file mode 100644
index 18b0f98..0000000
--- a/bot/add_character.py
+++ /dev/null
@@ -1,64 +0,0 @@
-import requests
-from misskey.exceptions import MisskeyAPIException
-from client import client_connection
-from db_utils import insert_character
-from custom_types import Character
-from config import RARITY_TO_WEIGHT
-
-
-def add_character(
- name: str,
- rarity: int,
- 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).
- 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.
- '''
-
- stripped_name = name.strip()
-
- # Validate inputs
- if not stripped_name:
- raise ValueError('Character name cannot be empty.')
- if rarity < 1:
- raise ValueError('Rarity must be a positive integer.')
- if rarity not in RARITY_TO_WEIGHT.keys():
- raise ValueError(f'Invalid rarity: {rarity}')
- 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(
- stripped_name,
- rarity,
- RARITY_TO_WEIGHT[rarity],
- file_id
- )
- return character_id, file_id
diff --git a/bot/bot_app.py b/bot/bot_app.py
index 825695e..9070415 100644
--- a/bot/bot_app.py
+++ b/bot/bot_app.py
@@ -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 misskey as misskey
-from client import client_connection
-import db_utils as db
+import traceback
+import config
+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 notification import process_notifications
+from config import USE_WHITELIST
-if __name__ == '__main__':
- # Initialize the Misskey client
- client = client_connection()
- # Connect to DB
- db.connect()
+def stream_notifications():
+ # Initialize database connection
+ 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...')
while True:
- if not process_notifications(client):
- time.sleep(NOTIFICATION_POLL_INTERVAL)
+ try:
+ # 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()
diff --git a/bot/client.py b/bot/client.py
deleted file mode 100644
index 57f9f4e..0000000
--- a/bot/client.py
+++ /dev/null
@@ -1,6 +0,0 @@
-import misskey
-import config
-
-
-def client_connection() -> misskey.Misskey:
- return misskey.Misskey(address=config.INSTANCE, i=config.KEY)
diff --git a/bot/config.py b/bot/config.py
index 227f949..f226d45 100644
--- a/bot/config.py
+++ b/bot/config.py
@@ -1,5 +1,23 @@
+# 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'''
import configparser
+import json
+import re
from os import environ, path
@@ -12,8 +30,10 @@ def get_config_file() -> str:
env: str | None = environ.get('KEMOVERSE_ENV')
if not env:
raise ConfigError('Error: KEMOVERSE_ENV is unset')
- if not (env in ['prod', 'dev']):
- raise ConfigError(f'Error: Invalid environment: {env}')
+
+ # 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'
@@ -21,7 +41,53 @@ def get_config_file() -> str:
raise ConfigError(f'Could not find {config_path}')
return config_path
-def get_rarity_to_weight(config_section):
+
+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():
@@ -35,22 +101,40 @@ config = configparser.ConfigParser()
config.read(get_config_file())
# Username for the bot
-USER = config['credentials']['User'].lower()
+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
KEY = config['credentials']['Token']
-# Bot's Misskey instance URL
+# Bot's Misskey/Pleroma instance URL
INSTANCE = config['credentials']['Instance'].lower()
-# TODO: move this to db
+# 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')
+
# Fedi handles in the traditional 'user@domain.tld' style, allows these users
# to use extra admin exclusive commands with the bot
-ADMINS = config['application']['DefaultAdmins']
+ADMINS = json.loads(config['application']['DefaultAdmins'])
# 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_BATCH_SIZE = int(config['notification']['BatchSize'])
GACHA_ROLL_INTERVAL = int(config['gacha']['RollInterval'])
-RARITY_TO_WEIGHT = get_rarity_to_weight(config['gacha'])
\ No newline at end of file
+RARITY_TO_WEIGHT = get_rarity_to_weight(config['gacha'])
diff --git a/bot/custom_types.py b/bot/custom_types.py
index 0c23cb6..6aad962 100644
--- a/bot/custom_types.py
+++ b/bot/custom_types.py
@@ -1,3 +1,19 @@
+# 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', {
@@ -5,7 +21,7 @@ BotResponse = TypedDict('BotResponse', {
'attachment_urls': List[str] | None
})
-Character = TypedDict('Character', {
+Card = TypedDict('Card', {
'id': int,
'name': str,
'rarity': int,
diff --git a/bot/db_utils.py b/bot/db_utils.py
index 68409be..45cac82 100644
--- a/bot/db_utils.py
+++ b/bot/db_utils.py
@@ -1,7 +1,23 @@
+# 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
import sqlite3
import config
-from custom_types import Character
+from custom_types import Card
DB_PATH = config.DB_PATH
CONNECTION: sqlite3.Connection
@@ -18,16 +34,38 @@ def connect() -> None:
CURSOR = CONNECTION.cursor()
-def get_random_character() -> Character | None:
- ''' Gets a random character from the database'''
- CURSOR.execute('SELECT * FROM characters')
- characters = CURSOR.fetchall()
+def setup_administrators() -> None:
+ '''Creates administrator players for each handle in the config file'''
+ # Get default admins from config
+ for username in config.ADMINS:
+ player_id = get_player(username)
+ if player_id == 0:
+ # Create player if not exists
+ print(f'Creating administrator player: {username}')
+ CURSOR.execute(
+ '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,)
+ )
- if not characters:
+
+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 characters]
- chosen = choices(characters, weights=weights, k=1)[0]
+ weights = [config.RARITY_TO_WEIGHT[c['rarity']] for c in cards]
+ chosen = choices(cards, weights=weights, k=1)[0]
return {
'id': chosen['id'],
@@ -37,76 +75,181 @@ def get_random_character() -> Character | None:
'image_url': chosen['file_id']
}
+def get_cards(card_ids: list[int]) -> list[tuple]:
+ '''
+ Retrieves stats for a list of card IDs.
+ Returns a list of tuples: (id, name, rarity, file_id, power, charm, wit, ...)
+ '''
+ if not card_ids:
+ return []
+
+ placeholders = ','.join('?' for _ in card_ids)
+ query = f'SELECT * FROM cards WHERE id IN ({placeholders})'
+
+ CURSOR.execute(query, card_ids)
+ return CURSOR.fetchall()
+
def get_player(username: str) -> int:
'''Retrieve a player ID by username, or return None if not found.'''
- CURSOR.execute('SELECT id FROM users WHERE username = ?', (username,))
- user = CURSOR.fetchone()
- if user:
- return int(user[0])
-
-def insert_player(username: str) -> int:
- '''Insert a new player with default has_rolled = False and return their user ID.'''
CURSOR.execute(
- 'INSERT INTO users (username, has_rolled) VALUES (?, ?)',
- (username, False)
- )
- return CURSOR.lastrowid
-
-def delete_player(username: str) -> bool:
- '''Permanently deletes a user and all their pulls.'''
- CURSOR.execute(
- 'SELECT id FROM users WHERE username = ?',
+ 'SELECT id FROM players WHERE username = ?',
(username,)
)
- user = CURSOR.fetchone()
+ player = CURSOR.fetchone()
+ if player:
+ return int(player[0])
+ return 0
- user_id = user[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)
+ )
+ return CURSOR.lastrowid if CURSOR.lastrowid else 0
+
+
+def delete_player(username: str) -> bool:
+ '''Permanently deletes a player and all their pulls.'''
+ CURSOR.execute(
+ 'SELECT id FROM players WHERE username = ?',
+ (username,)
+ )
+ player = CURSOR.fetchone()
+
+ if not player:
+ return False
+
+ player_id = player[0]
# Delete pulls
CURSOR.execute(
- 'DELETE FROM pulls WHERE user_id = ?',
- (user_id,)
+ 'DELETE FROM pulls WHERE player_id = ?',
+ (player_id,)
)
- # Delete user
+ # Delete player
CURSOR.execute(
- 'DELETE FROM users WHERE id = ?',
- (user_id,)
+ '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 insert_character(
- name: str, rarity: int, weight: float, file_id: str) -> int:
- '''Inserts a character'''
+
+def unban_player(username: str) -> bool:
+ '''Removes a player from the ban list.'''
CURSOR.execute(
- 'INSERT INTO characters (name, rarity, weight, file_id) VALUES \
-(?, ?, ?, ?)',
- (name, rarity, weight, file_id)
+ 'DELETE FROM banned_players WHERE handle = ?',
+ (username,)
)
- character_id = CURSOR.lastrowid
- return character_id if character_id else 0
+ return CURSOR.rowcount > 0
-def insert_pull(user_id: int, character_id: int) -> None:
+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,
+ power: int =None, charm: int = None, wit: int = None) -> int:
+ '''Inserts a card'''
+ if power is not None and charm is not None and wit is not None:
+ CURSOR.execute(
+ '''
+ INSERT INTO cards (name, rarity, file_id, power, charm, wit)
+ VALUES (?, ?, ?, ?, ?, ?)
+ ''',
+ (name, rarity, file_id, power, charm, wit)
+ )
+ else:
+ 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'''
CURSOR.execute(
- 'INSERT INTO pulls (user_id, character_id) VALUES (?, ?)',
- (user_id, character_id)
+ 'INSERT INTO pulls (player_id, card_id) VALUES (?, ?)',
+ (player_id, card_id)
)
-def get_last_rolled_at(user_id: int) -> int:
- '''Gets the timestamp when the user last rolled'''
+def get_last_rolled_at(player_id: int) -> int:
+ '''Gets the timestamp when the player last rolled'''
CURSOR.execute(
- "SELECT timestamp FROM pulls WHERE user_id = ? ORDER BY timestamp \
+ "SELECT timestamp FROM pulls WHERE player_id = ? ORDER BY timestamp \
DESC",
- (user_id,))
+ (player_id,))
row = CURSOR.fetchone()
return row[0] if row else 0
+# Configuration
+
+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'''
diff --git a/bot/fediverse_factory.py b/bot/fediverse_factory.py
new file mode 100644
index 0000000..d7d61b5
--- /dev/null
+++ b/bot/fediverse_factory.py
@@ -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)
\ No newline at end of file
diff --git a/bot/fediverse_service.py b/bot/fediverse_service.py
new file mode 100644
index 0000000..4bb4169
--- /dev/null
+++ b/bot/fediverse_service.py
@@ -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
\ No newline at end of file
diff --git a/bot/fediverse_types.py b/bot/fediverse_types.py
new file mode 100644
index 0000000..99d58ce
--- /dev/null
+++ b/bot/fediverse_types.py
@@ -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
\ No newline at end of file
diff --git a/bot/misskey_service.py b/bot/misskey_service.py
new file mode 100644
index 0000000..aad3944
--- /dev/null
+++ b/bot/misskey_service.py
@@ -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
\ No newline at end of file
diff --git a/bot/mock_fediverse_service.py b/bot/mock_fediverse_service.py
new file mode 100644
index 0000000..bc6546d
--- /dev/null
+++ b/bot/mock_fediverse_service.py
@@ -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()
\ No newline at end of file
diff --git a/bot/notification.py b/bot/notification.py
index 9427dbf..95a3292 100644
--- a/bot/notification.py
+++ b/bot/notification.py
@@ -1,51 +1,71 @@
-import traceback
-from typing import Dict, Any
+# Kemoverse - a gacha-style bot for the Fediverse.
+# Copyright © 2025 Waifu, Moon, VD15, and contributors.
-import misskey
-from misskey.exceptions import MisskeyAPIException
+# 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.
-from config import NOTIFICATION_BATCH_SIZE
+# 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 db_utils import get_config, set_config
+from db_utils import is_whitelisted, is_player_banned
from response import generate_response
from custom_types import BotResponse
-
-# Define your whitelist
-# TODO: move to config
-WHITELISTED_INSTANCES: list[str] = []
+from fediverse_factory import get_fediverse_service
+from fediverse_types import FediverseNotification, NotificationType, Visibility
-def process_notification(
- client: misskey.Misskey,
- notification: Dict[str, Any]) -> None:
- '''Processes an individual notification'''
- user = notification.get('user', {})
- username = user.get('username', 'unknown')
- host = user.get('host') # None if local user
+def process_fediverse_notification(notification: FediverseNotification, fediverse_service=None) -> None:
+ '''Processes an individual fediverse notification using the abstraction'''
+ if fediverse_service is None:
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
+
+ # Get user and instance info
+ username = notification.user.username
+ host = notification.user.host
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}')
return
- # Copy visibility of the post that was received when replying (so if people
- # don't want to dump a bunch of notes on home they don't have to)
- visibility = notification['note']['visibility']
- if visibility != 'specified':
- visibility = 'home'
+ # Only process mentions and replies
+ if notification.type not in (NotificationType.MENTION, NotificationType.REPLY):
+ return
- notif_type = notification.get('type', 'unknown')
- notif_id = notification.get('id')
+ # Return early if no post attached
+ 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}')
# 🧠 Send to the parser
- parsed_notification = parse_notification(notification, client)
+ parsed_notification = parse_notification(notification, fediverse_service)
if not parsed_notification:
return
- # Get the note Id to reply to
- note_id = notification.get('note', {}).get('id')
+ author = parsed_notification['author']
+ if is_player_banned(author):
+ print(f'⚠️ Blocked notification from banned player: {author}')
+ return
# Get the response
response: BotResponse | None = generate_response(parsed_notification)
@@ -53,70 +73,14 @@ def process_notification(
if not response:
return
- client.notes_create(
+ # Handle attachment URLs (convert to file IDs if needed)
+ file_ids = response['attachment_urls'] if response['attachment_urls'] else None
+
+ # Send response using fediverse service
+ fediverse_service.create_post(
text=response['message'],
- reply_id=note_id,
+ reply_to_id=notification.post.id,
visibility=visibility,
- file_ids=response['attachment_urls']
- # TODO: write actual visible users ids so pleromers can use the bot
- # privately
- # visible_user_ids=[]
+ file_ids=file_ids
+ # visible_user_ids=[] # TODO: write actual visible users ids so pleromers can use the bot privately
)
-
-
-def process_notifications(client: misskey.Misskey) -> bool:
- '''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
diff --git a/bot/parsing.py b/bot/parsing.py
index eece077..7cadd79 100644
--- a/bot/parsing.py
+++ b/bot/parsing.py
@@ -1,29 +1,58 @@
+# 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
-from typing import Dict, Any
-
-import misskey
-
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: FediverseNotification, fediverse_service=None):
+ '''Parses any notifications received by the bot and sends any commands to
+ generate_response()'''
+
+ if fediverse_service is None:
+ fediverse_service = get_fediverse_service(config.INSTANCE_TYPE)
-def parse_notification(
- notification: Dict[str, Any],
- client: misskey.Misskey) -> ParsedNotification | None:
- '''Parses any notifications received by the bot'''
+ # 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
- user = notification.get("user", {})
- 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}"
+ full_user = notification.user.full_handle
- note_obj = notification.get("note", {})
- note_text = note_obj.get("text")
- note_id = note_obj.get("id")
+ note_text = notification.post.text
+ note_id = notification.post.id
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
username_variants = [
@@ -31,22 +60,41 @@ def parse_notification(
f'@{config.USER.split("@")[1]}'
]
- # Make sure the notification text explicitly mentions the bot
- if not any(variant in note for variant in username_variants):
+ # Notifs must consist of the initial mention and at least one other token
+ if len(parts) <= 1:
return None
- # Find command and arguments after the mention
- # Removes all mentions
- # regex = mentions that start with @ and may contain @domain
- cleaned_text = re.sub(r"@\w+(?:@\S+)?", "", note).strip()
- parts = cleaned_text.split()
+ # Make sure the first token is a mention to the bot
+ if not parts[0] in username_variants:
+ return None
- command = parts[0].lower() if parts else None
- arguments = parts[1:] if len(parts) > 1 else []
+ command = parts[1].lower()
+ arguments = parts[2:] if len(parts) > 2 else []
- return {
+ # Create ParsedNotification object for the new response system
+ parsed_notification: ParsedNotification = {
'author': full_user,
'command': command,
'arguments': arguments,
- 'note_obj': note_obj
+ '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
+
+ # Handle attachment URLs (convert to file IDs if needed)
+ file_ids = response['attachment_urls'] if response['attachment_urls'] else None
+
+ fediverse_service.create_post(
+ text=response['message'],
+ reply_to_id=note_id,
+ visibility=visibility,
+ file_ids=file_ids
+ #visible_user_ids=[] #todo: write actual visible users ids so pleromers can use the bot privately
+ )
diff --git a/bot/pleroma_service.py b/bot/pleroma_service.py
new file mode 100644
index 0000000..4886c90
--- /dev/null
+++ b/bot/pleroma_service.py
@@ -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
\ No newline at end of file
diff --git a/bot/response.py b/bot/response.py
index 3fde3ed..8ec698e 100644
--- a/bot/response.py
+++ b/bot/response.py
@@ -1,22 +1,38 @@
+#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 typing import TypedDict, Any, List, Dict
-from db_utils import get_player, insert_player, delete_player, insert_pull, get_last_rolled_at, \
- get_random_character
-from add_character import add_character
+import db_utils as db
+from add_card import add_card
from config import GACHA_ROLL_INTERVAL
from custom_types import BotResponse, ParsedNotification
def do_roll(author: str) -> BotResponse:
- '''Determines whether the user can roll, then pulls a random character'''
- user_id = get_player(author)
+ '''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
+ '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
- date = get_last_rolled_at(user_id)
+ date = db.get_last_rolled_at(user_id)
# No date means it's users first roll
if date:
@@ -45,39 +61,43 @@ def do_roll(author: str) -> BotResponse:
'attachment_urls': None
}
- character = get_random_character()
+ card = db.get_random_card()
- if not character:
+ if not card:
return {
'message': f'{author} Uwaaa... something went wrong! No \
-characters found. 😿',
+cards found. 😿',
'attachment_urls': None
}
- insert_pull(user_id, character['id'])
- stars = '⭐️' * character['rarity']
+ db.insert_pull(user_id, card['id'])
+ stars = '⭐️' * card['rarity']
return {
'message': f'{author} 🎲 Congrats! You rolled {stars} \
-**{character['name']}**\nShe\'s all yours now~ 💖✨',
- 'attachment_urls': [character['image_url']]
+**{card['name']}**\nShe\'s all yours now~ 💖✨',
+ 'attachment_urls': [card['image_url']]
}
+
def do_signup(author: str) -> BotResponse:
'''Registers a new user if they haven’t signed up yet.'''
- user_id = get_player(author)
+ user_id = db.get_player(author)
if user_id:
return {
- 'message':f'{author} 👀 You’re already signed up! Let the rolling begin~ 🎲',
+ 'message': f'{author} 👀 You’re already signed up! Let the rolling \
+begin~ 🎲',
'attachment_urls': None
}
- new_user_id = insert_player(author)
+ 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!',
+ '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'''
try:
@@ -91,22 +111,22 @@ def do_create(
author: str,
arguments: List[str],
note_obj: Dict[str, Any]) -> BotResponse:
- '''Creates a character'''
+ '''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 character, \
+ 'message': f'{author} You need an image to create a card, \
dumbass.',
'attachment_urls': None
}
- if len(arguments) != 2:
+ if not(len(arguments) in (2,5)):
return {
'message': f'{author} Please specify the following attributes \
-in order: name, rarity',
+in order: name, rarity. Optionally add [power, charm, wit].',
'attachment_urls': None
}
@@ -116,20 +136,35 @@ in order: name, rarity',
be a number between 1 and 5',
'attachment_urls': None
}
- if not (is_float(arguments[2]) and 0.0 < float(arguments[2]) <= 1.0):
- return {
- 'message': f'{author} Invalid drop weight: \'{arguments[2]}\' \
-must be a decimal value between 0.0 and 1.0',
- 'attachment_urls': None
- }
- character_id, file_id = add_character(
+ if len(arguments) == 2:
+ pass
+ else:
+ if not all(arg.isnumeric() for arg in arguments[2:]):
+ return {
+ 'message': f'{author} Invalid attributes: power, charm and \
+wit must be numbers.',
+ 'attachment_urls': None
+ }
+ card_id, file_id = add_card(
+ name=arguments[0],
+ rarity=int(arguments[1]),
+ image_url=image_url,
+ power=int(arguments[2]),
+ charm=int(arguments[3]),
+ wit=int(arguments[4])
+ )
+ return {
+ 'message': f'{author} Added {arguments[0]}, ID {card_id}.',
+ 'attachment_urls': [file_id]
+ }
+ card_id, file_id = add_card(
name=arguments[0],
rarity=int(arguments[1]),
image_url=image_url
)
return {
- 'message': f'{author} Added {arguments[0]}, ID {character_id}.',
+ 'message': f'{author} Added {arguments[0]}, ID {card_id}.',
'attachment_urls': [file_id]
}
@@ -137,59 +172,145 @@ must be a decimal value between 0.0 and 1.0',
def do_help(author: str) -> BotResponse:
'''Provides a list of commands that the bot can do.'''
return {
- 'message':f'{author} Here\'s what I can do:\n \
- - `roll` Pulls a random character.\
- - `create ` Creates a character using a given image.\
- - `signup` Registers your account.\
- - `delete_account` Deletes your account.\
- - `help` Shows this message',
- 'attachment_urls': None
+ 'message': f'{author} Here\'s what I can do:\n\
+- `roll` Pulls a random card.\n\
+- `create ` 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 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` to proceed.\n\n'
+ '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:
-
- delete_player(author)
+ db.delete_player(author)
return {
- 'message':f'{author} 🧼 Your account and all your cards have been deleted. RIP your gacha history 🕊️✨',
+ '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
returns a response'''
# Temporary response variable
res: BotResponse | None = None
- # TODO: Check if the user has an account
author = notification['author']
- user_id = get_player(author)
+ player_id = db.get_player(author)
command = notification['command']
- # Check if the user is an administrator
- # user_is_administrator = user_is_administrator()
# Unrestricted commands
match command:
+ case 'roll':
+ res = do_roll(author)
case 'signup':
res = do_signup(author)
case 'help':
res = do_help(author)
- case 'roll':
- res = do_roll(author)
case _:
pass
- if not user_id:
+ # Commands beyond this point require the user to have an account
+ if not player_id:
return res
# User commands
@@ -200,15 +321,29 @@ def generate_response(notification: ParsedNotification) -> BotResponse | None:
notification['arguments'],
notification['note_obj']
)
- case 'signup':
- res = do_signup(author)
case 'delete_account':
res = delete_account(author)
- case 'confirm_delete':
+ case 'confirm_delete_account':
res = confirm_delete(author)
case _:
pass
- # if not user_is_administrator:
- return res
+
+ # 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
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..5858d9e
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,49 @@
+
+
+# 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 💫
\ No newline at end of file
diff --git a/dev_runner.py b/dev_runner.py
index b39a434..92fd0aa 100644
--- a/dev_runner.py
+++ b/dev_runner.py
@@ -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 os
from watchdog.observers import Observer
diff --git a/docs/images/cards/bg.png b/docs/images/cards/bg.png
new file mode 100644
index 0000000..dd3344b
Binary files /dev/null and b/docs/images/cards/bg.png differ
diff --git a/docs/images/cards/card_back.png b/docs/images/cards/card_back.png
new file mode 100644
index 0000000..8aea02e
Binary files /dev/null and b/docs/images/cards/card_back.png differ
diff --git a/docs/images/cards/example.png b/docs/images/cards/example.png
new file mode 100644
index 0000000..03699e3
Binary files /dev/null and b/docs/images/cards/example.png differ
diff --git a/docs/images/cards/special_card.png b/docs/images/cards/special_card.png
new file mode 100644
index 0000000..ae9dabf
Binary files /dev/null and b/docs/images/cards/special_card.png differ
diff --git a/docs/images/cards/svg/card_back.svg b/docs/images/cards/svg/card_back.svg
new file mode 100644
index 0000000..4b97844
--- /dev/null
+++ b/docs/images/cards/svg/card_back.svg
@@ -0,0 +1,365 @@
+
+
diff --git a/docs/images/cards/svg/card_base_gray.svg b/docs/images/cards/svg/card_base_gray.svg
new file mode 100644
index 0000000..feef7ce
--- /dev/null
+++ b/docs/images/cards/svg/card_base_gray.svg
@@ -0,0 +1,338 @@
+
+
diff --git a/docs/images/logo/logo black monochrome.png b/docs/images/logo/logo black monochrome.png
new file mode 100644
index 0000000..14c9b8a
Binary files /dev/null and b/docs/images/logo/logo black monochrome.png differ
diff --git a/docs/images/logo/logo darkKemoverse.png b/docs/images/logo/logo darkKemoverse.png
new file mode 100644
index 0000000..270e3c3
Binary files /dev/null and b/docs/images/logo/logo darkKemoverse.png differ
diff --git a/docs/images/logo/logo green monochrome.png b/docs/images/logo/logo green monochrome.png
new file mode 100644
index 0000000..e3c26d5
Binary files /dev/null and b/docs/images/logo/logo green monochrome.png differ
diff --git a/docs/images/logo/logo light green monochrome 2.png b/docs/images/logo/logo light green monochrome 2.png
new file mode 100644
index 0000000..4da0130
Binary files /dev/null and b/docs/images/logo/logo light green monochrome 2.png differ
diff --git a/docs/images/logo/logo light green monochrome.png b/docs/images/logo/logo light green monochrome.png
new file mode 100644
index 0000000..cc9b003
Binary files /dev/null and b/docs/images/logo/logo light green monochrome.png differ
diff --git a/docs/images/logo/logo lightKemoverse.png b/docs/images/logo/logo lightKemoverse.png
new file mode 100644
index 0000000..955ac0f
Binary files /dev/null and b/docs/images/logo/logo lightKemoverse.png differ
diff --git a/docs/images/logo/logo no text.png b/docs/images/logo/logo no text.png
new file mode 100644
index 0000000..b310fa0
Binary files /dev/null and b/docs/images/logo/logo no text.png differ
diff --git a/docs/images/logo/logo white monochrome.png b/docs/images/logo/logo white monochrome.png
new file mode 100644
index 0000000..eed96fc
Binary files /dev/null and b/docs/images/logo/logo white monochrome.png differ
diff --git a/docs/images/logo/logo.png b/docs/images/logo/logo.png
new file mode 100644
index 0000000..dbbd227
Binary files /dev/null and b/docs/images/logo/logo.png differ
diff --git a/docs/images/logo/logoLibbie.png b/docs/images/logo/logoLibbie.png
new file mode 100644
index 0000000..3decf21
Binary files /dev/null and b/docs/images/logo/logoLibbie.png differ
diff --git a/docs/images/logo/svg/Logo con mascotaKemoverse.svg b/docs/images/logo/svg/Logo con mascotaKemoverse.svg
new file mode 100644
index 0000000..f1af378
--- /dev/null
+++ b/docs/images/logo/svg/Logo con mascotaKemoverse.svg
@@ -0,0 +1,181 @@
+
+
\ No newline at end of file
diff --git a/docs/images/logo/svg/LogoKemoverse.svg b/docs/images/logo/svg/LogoKemoverse.svg
new file mode 100644
index 0000000..a23b2dd
--- /dev/null
+++ b/docs/images/logo/svg/LogoKemoverse.svg
@@ -0,0 +1,35 @@
+
+
\ No newline at end of file
diff --git a/docs/images/logo/svg/SimboloKemoverse.svg b/docs/images/logo/svg/SimboloKemoverse.svg
new file mode 100644
index 0000000..ce282b2
--- /dev/null
+++ b/docs/images/logo/svg/SimboloKemoverse.svg
@@ -0,0 +1,22 @@
+
+
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..f6ad524
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,41 @@
+
+# 🎲 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)
+
+---
+
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 0000000..8584b79
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,100 @@
+
+
+## 🧪 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
+```
diff --git a/docs/theme.md b/docs/theme.md
new file mode 100644
index 0000000..bcd8bfe
--- /dev/null
+++ b/docs/theme.md
@@ -0,0 +1,99 @@
+
+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
+
+
+ 
+
+
+- Usage: Favicon, watermark
+
+### Mascot Logo
+
+
+ 
+
+
+- Usage: Bot profile picture
+
+
+---
+
+## Cards
+
+### Standard card template
+
+Here is a template card for the main game to use.
+
+ 
+ 
+
+
+---
+## Other logo versions
+
+### No text
+
+
+
+
+
+### Monochrome
+
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+
+## Extras
+
+
+ 
+ 
+
+
+The svg can be found in the images folder of the documentation.
+
+All of the pieces of media in this repository, including images, video or audio are licensed under Creative Commons Attribution-ShareAlike 4.0 International unless stated otherwise © 2025 by Waifu and contributors CC BY-SA 4.0
\ No newline at end of file
diff --git a/example_config.ini b/example_config.ini
index af7e0f2..b147f34 100644
--- a/example_config.ini
+++ b/example_config.ini
@@ -1,10 +1,37 @@
+; 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
[application]
; Comma separated list of fedi handles for any administrator users
; More can be added through the application
-DefaultAdmins = ['admin@example.tld']
+DefaultAdmins = ["@localadmin", "@remoteadmin@example.tld"]
; SQLite Database location
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]
; Number of seconds players have to wait between rolls
@@ -32,4 +59,3 @@ User = @bot@example.tld
; API key for the bot
; Generate one by going to Settings > API > Generate access token
Token = abcdefghijklmnopqrstuvwxyz012345
-
diff --git a/migrations/0000_setup.sql b/migrations/0000_setup.sql
index 4dcbc64..2f0dd85 100644
--- a/migrations/0000_setup.sql
+++ b/migrations/0000_setup.sql
@@ -1,3 +1,20 @@
+/*
+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,
diff --git a/migrations/0001_fix_notif_id.sql b/migrations/0001_fix_notif_id.sql
index 3494d6e..bf7eb2e 100644
--- a/migrations/0001_fix_notif_id.sql
+++ b/migrations/0001_fix_notif_id.sql
@@ -1 +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);
diff --git a/migrations/0002_weigh_infer.sql b/migrations/0002_weigh_infer.sql
index 28a1002..cf571f1 100644
--- a/migrations/0002_weigh_infer.sql
+++ b/migrations/0002_weigh_infer.sql
@@ -1 +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;
diff --git a/migrations/0003_rename_tables.sql b/migrations/0003_rename_tables.sql
new file mode 100644
index 0000000..7d9e0c4
--- /dev/null
+++ b/migrations/0003_rename_tables.sql
@@ -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;
diff --git a/migrations/0004_add_administrators.sql b/migrations/0004_add_administrators.sql
new file mode 100644
index 0000000..51bef49
--- /dev/null
+++ b/migrations/0004_add_administrators.sql
@@ -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;
diff --git a/migrations/0005_add_whitelist.sql b/migrations/0005_add_whitelist.sql
new file mode 100644
index 0000000..7769253
--- /dev/null
+++ b/migrations/0005_add_whitelist.sql
@@ -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
+);
diff --git a/migrations/0006_card_stats.sql b/migrations/0006_card_stats.sql
new file mode 100644
index 0000000..780cd75
--- /dev/null
+++ b/migrations/0006_card_stats.sql
@@ -0,0 +1,26 @@
+/*
+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/.
+*/
+
+ALTER TABLE cards
+ ADD COLUMN power INTEGER NOT NULL DEFAULT 0;
+
+ALTER TABLE cards
+ ADD COLUMN charm INTEGER NOT NULL DEFAULT 0;
+
+ALTER TABLE cards
+ ADD COLUMN wit INTEGER NOT NULL DEFAULT 0;
\ No newline at end of file
diff --git a/readme.md b/readme.md
index 40d723d..40e41e3 100644
--- a/readme.md
+++ b/readme.md
@@ -1,12 +1,33 @@
+
+
# 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. Currently designed for use with Misskey. Name comes from Kemonomimi and Fediverse.
+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.
+
+ 
+
-## Installation
+## 📝 Docs
-## Roadmap
+👉 [**Start reading the docs**](./docs/index.md)
-
+🤌 [**Install instructions for those in a rush**](docs/install.md)
## 🔧 Features
@@ -15,10 +36,11 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🧠 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
-- ⚠️ Explicit account creation/deletion
+
## 🧠 Roadmap
@@ -43,13 +65,13 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
- 🌐 Web app to generate cards from images
### 🌍 Fediverse Support
-✅ Anyone from the fediverse can play, but the server only works using a Misskey instance. Want to rewrite the program in Elixir for Pleroma? Let us know!
+✅ 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 (via Misskey endpoints)
+- Fediverse API integration (Misskey and Pleroma support)
- Flask
- Modular DB design for extensibility
@@ -57,99 +79,42 @@ A gacha-style bot for the Fediverse built with Python. Users can roll for charac
The bot is meant to feel *light, fun, and competitive*. Mixing social, gacha and duel tactics.
-## 🧪 Installation
+## 📝 License
-### Download and install dependencies
+Unless stated otherwise, this repository is:
-Clone the repo
+**Copyright © 2025 Waifu and contributors**
+**Licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)**
-```sh
-git clone https://git.waifuism.life/waifu/kemoverse.git
-cd kemoverse
-```
+---
-Setup a virtual environment (Optional, recommended)
+### 🛠️ What this means for you:
-```sh
-python3 -m venv venv
-source venv/bin/activate
-```
+- 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.
-Install project dependencies via pip
+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/).
-```sh
-python3 -m pip install -r requirements.txt
-```
+---
-### Setup config file
+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.
-A sample config file is included with the project as a template: `example_config.ini`
+Unless explicitly stated otherwise, **all files in this repository are covered by the AGPL v3.0 or any later version**.
-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
-```
```mermaid
flowchart TD
subgraph Player Interaction
- A1[Misskey bot]
+ A1[Fediverse bot]
A2[Web]
end
- subgraph Misskey
- B1[Misskey instance]
+ subgraph Fediverse
+ B1[Fediverse instance]
end
subgraph Bot
@@ -157,7 +122,7 @@ flowchart TD
C2[Notification parser]
C3[Gacha roll logic]
C4[Database interface]
- C5[Misskey API poster]
+ C5[Fediverse API poster]
end
subgraph Website
diff --git a/requirements.txt b/requirements.txt
index 1db6f9b..d747e71 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -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
click==8.1.8
Flask==3.1.0
@@ -6,3 +22,5 @@ Jinja2==3.1.6
MarkupSafe==3.0.2
Werkzeug==3.1.3
Misskey.py==4.1.0
+Mastodon.py==1.8.1
+filetype==1.2.0
diff --git a/setup_db.py b/setup_db.py
index 241bb4e..45b3aba 100644
--- a/setup_db.py
+++ b/setup_db.py
@@ -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 sqlite3
import traceback
import os
@@ -57,16 +73,14 @@ def perform_migration(cursor: sqlite3.Cursor, migration: tuple[int, str]) -> Non
def get_db_path() -> str | DBNotFoundError:
'''Gets the DB path from config.ini'''
env = os.environ.get('KEMOVERSE_ENV')
- if not (env and env in ['prod', 'dev']):
- raise KemoverseEnvUnset
-
- print(f'Running in "{env}" mode')
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']
@@ -96,7 +110,6 @@ def main():
return
except KemoverseEnvUnset:
print('Error: KEMOVERSE_ENV is either not set or has an invalid value.')
- print('Please set KEMOVERSE_ENV to either "dev" or "prod" before running.')
print(traceback.format_exc())
return
diff --git a/startup.sh b/startup.sh
index 7c216b6..3741e71 100755
--- a/startup.sh
+++ b/startup.sh
@@ -1,5 +1,21 @@
#!/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)
cd "$(dirname "$0")"
diff --git a/web/app.py b/web/app.py
index 9c5965c..56ae25a 100644
--- a/web/app.py
+++ b/web/app.py
@@ -1,13 +1,34 @@
+#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 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__)
-DB_PATH = "./gacha_game.db" # Adjust path if needed
def get_db_connection():
- conn = sqlite3.connect(DB_PATH)
+ conn = sqlite3.connect(config.DB_PATH)
conn.row_factory = sqlite3.Row
return conn
@@ -72,4 +93,4 @@ def card():
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)
diff --git a/web/static/style.css b/web/static/style.css
index 74231c1..95380a8 100644
--- a/web/static/style.css
+++ b/web/static/style.css
@@ -1,13 +1,30 @@
+/*
+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: #f4f6fa;
+ background-color: #FAFAFA;
color: #333;
margin: 0;
padding: 0;
}
header {
- background-color: #7289da;
+ background-color: #5aa02c;
color: white;
padding: 20px;
text-align: center;
diff --git a/web/templates/_base.html b/web/templates/_base.html
index a1f1b22..f025c75 100644
--- a/web/templates/_base.html
+++ b/web/templates/_base.html
@@ -1,3 +1,20 @@
+
diff --git a/web/templates/_error.html b/web/templates/_error.html
index defc5d8..6d18f04 100644
--- a/web/templates/_error.html
+++ b/web/templates/_error.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block title %}
{{ error.code }}
diff --git a/web/templates/about.html b/web/templates/about.html
index 184fde9..b704664 100644
--- a/web/templates/about.html
+++ b/web/templates/about.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}
diff --git a/web/templates/index.html b/web/templates/index.html
index f9bf7a0..6f2351d 100644
--- a/web/templates/index.html
+++ b/web/templates/index.html
@@ -1,3 +1,21 @@
+
+
{% extends "_base.html" %}
{% block header %}
diff --git a/web/templates/submit.html b/web/templates/submit.html
index d0424b8..ad36de4 100644
--- a/web/templates/submit.html
+++ b/web/templates/submit.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}
diff --git a/web/templates/user.html b/web/templates/user.html
index 8010538..1ccb447 100644
--- a/web/templates/user.html
+++ b/web/templates/user.html
@@ -1,3 +1,20 @@
+
{% extends "_base.html" %}
{% block content %}