You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"fpclib" stands for "Flashpoint Curation Library" and is a powerful collection of functions and classes you can use and extend to hopefully curate any game/animation in existence through python3. If you're not familiar with curating for Flashpoint and would like to know how to curate, first follow the [Curation Tutorial](https://bluemaxima.org/flashpoint/datahub/Curation_Tutorial) page on the Flashpoint wiki. If you're not familiar with using python or coding, you should read the [official python tutorial](https://docs.python.org/3/tutorial/index.html) before using this library.
3
+
4
+
Although there are already several useful tools you can use for manually curating games/animations for Flashpoint and downloading assets easily, such as Flashpoint Core, cURLsDownloader, and MAD4FP, none of these tools offer the ability to curate through code or automate the process; fpclib was created to fix that. [fpcurator](https://github.com/FlashpointProject/fpcurator) uses fpclib to automatically generate curations. Of course, you should still always manually check any curation you make with fpclib in Flashpoint Core to make sure it works properly.
5
+
6
+
There are numerous benefits of using fpclib/fpcurator to help you curate:
7
+
8
+
* By default, fpclib downloads main game/animation files and puts them in the right file format based upon your launch commands.
9
+
* Logos and screenshots can be automatically downloaded from online and converted to PNG files.
10
+
* Curating similar games/animations from one or more websites is simple and easy thanks to the `fpclib.curate()` function.
11
+
***Nearly every kind of Curation is possible to make with this library!** This library and documentation were created with the intent of making it easy to overwrite the Curation class to make it do different things. Anything you can do in the "Curate" tab in Flashpoint Core you can do with fpclib, except test games.
12
+
13
+
Here's some example code of using the library to curate "Interactive Buddy" from Newgrounds:
# Export this curation to the current working directory
35
+
curation.save()
36
+
```
37
+
38
+
You can also test the library by running the script directly or with `fpclib.test()`, which will also curate "Interactive Buddy" in the current working directory, delete the curation, and check an invalid curation.
39
+
40
+
## More Reading
41
+
42
+
You can read more about this library in the [official documentation](https://www.mathgeniuszach.com/bin/fpclib/).
43
+
44
+
## Usage
45
+
46
+
You can install the library with:
47
+
```
48
+
pip install fpclib
49
+
```
50
+
51
+
or you can put the "fpclib" script (check the releases page) in the same directory as your script.
52
+
53
+
If you choose the second option, you'll also need to install these libraries through pip:
54
+
```
55
+
pip install requests
56
+
pip install beautifulsoup4
57
+
pip install pillow
58
+
pip install ruamel.yaml
59
+
```
60
+
61
+
Once you have all of that set up, you can put `import fpclib` at the top of your script to use it's methods.
62
+
63
+
## License
64
+
65
+
<arel="license"href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><imgalt="Creative Commons License"style="border-width:0"src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br/>This work is licensed under a <arel="license"href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
Copy file name to clipboardExpand all lines: doc/source/index.rst
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Home
6
6
7
7
.. toctree::
8
8
:hidden:
9
-
9
+
10
10
basics
11
11
advanced
12
12
globals
@@ -21,13 +21,13 @@ General Overview
21
21
================
22
22
"fpclib" stands for "Flashpoint Curation Library" and is a powerful collection of functions and classes you can use and extend to hopefully curate any game/animation in existence through python3. If you're not familiar with curating for Flashpoint and would like to know how to curate, first follow the `Curation Tutorial <https://bluemaxima.org/flashpoint/datahub/Curation_Tutorial>`_ page on the Flashpoint wiki. If you're not familiar with using python or coding, you should read the `official python tutorial <https://docs.python.org/3/tutorial/index.html>`_ before using this library.
23
23
24
-
Although there are already several useful tools you can use for manually curating games/animations for Flashpoint and downloading assets easily, such as Flashpoint Core, cURLsDownloader, and MAD4FP, none of these tools offer the ability to curate through code or automate the process; fpclib was created to fix that. Of course, you should still always manually check any curation you make with fpclib in Flashpoint Core to make sure it works properly.
24
+
Although there are already several useful tools you can use for manually curating games/animations for Flashpoint and downloading assets easily, such as Flashpoint Core, cURLsDownloader, and MAD4FP, none of these tools offer the ability to curate through code or automate the process; fpclib was created to fix that. `fpcurator <https://github.com/FlashpointProject/fpcurator>`_ uses fpclib to automatically generate curations. Of course, you should still always manually check any curation you make with fpclib in Flashpoint Core to make sure it works properly.
25
25
26
-
There are numerous benefits of using fpclib to help you curate:
26
+
There are numerous benefits of using fpclib/fpcurator to help you curate:
27
27
28
28
* By default, fpclib downloads main game/animation files and puts them in the right file format based upon your launch commands.
29
29
* Logos and screenshots can be automatically downloaded from online and converted to PNG files.
30
-
* Curating similar games/animations from one or more websites is simple and easy thanks to the :func:`fpclib.curate()` function.
30
+
* Curating similar games/animations from one or more websites is simple and easy thanks to the :code:`fpclib.curate()` function.
31
31
* **Nearly every kind of Curation is possible to make with this library!** This library and documentation were created with the intent of making it easy to overwrite the Curation class to make it do different things. Anything you can do in the "Curate" tab in Flashpoint Core you can do with fpclib, except test games.
32
32
33
33
Here's some example code of using the library to curate "Interactive Buddy" from Newgrounds::
@@ -39,22 +39,22 @@ Here's some example code of using the library to curate "Interactive Buddy" from
# Export this curation to the current working directory
55
55
curation.save()
56
56
57
-
You can also test the library by running the script directly or with :func:`fpclib.test()`, which will also curate "Interactive Buddy" in the current working directory, delete the curation, and check an invalid curation.
57
+
You can also test the library by running the script directly or with :code:`fpclib.test()`, which will also curate "Interactive Buddy" in the current working directory, delete the curation, and check an invalid curation.
58
58
59
59
More Reading
60
60
============
@@ -69,12 +69,11 @@ More Reading
69
69
Usage
70
70
=====
71
71
72
-
You can install the library with
73
-
::
72
+
You can install the library with::
74
73
75
74
pip install fpclib
76
75
77
-
or you can put the "fpclib.py" script (check the releases page on `github <https://github.com/xMGZx/fpclib>`_) in the same directory as your script.
76
+
or you can put the "fpclib" script (check the releases page) in the same directory as your script.
78
77
79
78
If you choose the second option, you'll also need to install these libraries through pip::
80
79
@@ -85,9 +84,9 @@ If you choose the second option, you'll also need to install these libraries thr
85
84
86
85
Once you have all of that set up, you can put :code:`import fpclib` at the top of your script to use it's methods.
87
86
88
-
Licence
87
+
License
89
88
=======
90
89
91
90
.. raw:: html
92
-
91
+
93
92
<arel="license"href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><imgalt="Creative Commons License"style="border-width:0"src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br/>This work is licensed under a <arel="license"href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
0 commit comments