plugin.program.simplewizard/QuickGuide.txt at main · Slamious/plugin.program.simplewizard · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<><><> Simple Wizard <><><>

Simple Wizard is a lightweight build installer for Kodi 19 and later. It includes a Fresh Start option along with a small collection of maintenance tools.

Build information can be stored in either an XML, JSON or txt file. Template files (`builds.xml`, `builds.json`, `builds.txt`) are included in the `resources/texts/` folder. If using XML, be sure to preserve the existing tag structure. If using JSON or txt, keep the dictionary structure the same.

Please report any bugs or feature requests to **@slamious** on Telegram or X (Twitter).


<><><> Quick Start Guide <><><>

1. Extract `plugin.program.simplewizard.zip`.

2. Rename the `plugin.program.simplewizard` folder to your desired plugin ID.

   Example: `plugin.program.mywizard`

3. Open `addon.xml` and change the add-on ID to match the folder name you created in Step 2.

   You should also update the following fields:
   * Name
   * Provider Name
   * Summary
   * Description

   - Save the file when finished.

4. Replace `icon.png` and `fanart.jpg` in the `resources` folder with your own artwork. Keep the filenames the same.

5. Open either `builds.xml`, `builds.json`, `builds.txt` in the `resources/texts/` folder and replace the template information with your own build details.

   - You may add or remove builds as needed, but be sure to preserve the XML tag structure or JSON dictionary structure. You may also rename the file if desired.
   - Host the completed file on your web server.

6. Open `uservar.py` and change the build file URL to the URL of your hosted XML, JSON or txt build file. Save the file.

7. Zip your renamed plugin folder (Example, `plugin.program.mywizard.zip`) and install it in Kodi.


<><><> Changelog Guide <><><>

1. Name the changelog file:

   Example: `build_name.txt`

   - Replace `build_name` with the exact name of your build as it appears in your XML, JSON or txt build file.

2. Upload the changelog file to a directory on your web server.

3. In `uservar.py`, set the changelog directory URL. The URL must end with a forward slash (/).

   Example: `http://my_changelog_directory/`

   - Once a build has been installed, the wizard automatically matches the build name against the changelog files in the changelog directory on your web server and retrieves the corresponding changelog for that build.