User:Rizbot: Difference between revisions

From Rhythm Game Wiki
Jump to navigation Jump to search
Line 24: Line 24:
=== Output ===
=== Output ===
When run, the bot automatically updates:
When run, the bot automatically updates:
* Instances of [[Template:RizlineSongInfoBox|RizlineSongInfoBox]] templates (using the <code>rizline_song_info_box</code> command), which are in all pages contained in [[:Category:Rizline songs]].
* Lists of songs (using the <code>rizline_song_list</code> command), which are in the following pages:
* Lists of songs (using the <code>rizline_song_list</code> command), which are in the following pages:
** [[Rizline:List of songs]]  
** [[Rizline:List of songs]]  
Line 30: Line 31:
** [[Rizline:Disc EX]]
** [[Rizline:Disc EX]]
** [[Rizline:Coin]]
** [[Rizline:Coin]]
* Instances of [[Template:RizlineSongInfoBox|RizlineSongInfoBox]] templates (using the <code>rizline_song_info_box</code> command), which are in all pages contained in [[:Category:Rizline songs]].


Planned functionality includes automatic updating and generation of:
Planned functionality includes automatic updating and generation of:
* Song statistics - note counts, colors, etc.
* Song statistics - note counts, colors, etc.
* Asset tables for songs
* Asset tables for songs
* The achievement table


== Usage ==
== Usage ==

Revision as of 15:02, 6 January 2025

Rizbot
File:WikiBot Rizbot Image.png
Description A bot that automatically updates Rizline pages with game data.
Creator User:TadeLn
Source code GitLab
License GNU General Public License v3.0

A bot created by User:TadeLn that automatically updates Rizline data on the wiki. Source code is available on GitLab.

Status

Last Login

Last login to Rizbot occurred at: 2025-01-10T18:35:41.947939211Z (using mediawiki-rizbot)

Functionality and scope

This bot is a work-in-progress. Currently not all functionality is implemented.

Input

The bot fetches JSON data from the following pages to generate blocks of wikitext:


Output

When run, the bot automatically updates:

Planned functionality includes automatic updating and generation of:

  • Song statistics - note counts, colors, etc.
  • Asset tables for songs
  • The achievement table

Usage

When run, the bot searches the wiki for specific markers within HTML comments (described below), and finds the appropriate function to use. It then replaces the text between the BEGIN and END markers with generated content. If the content is different from what it was originally, the bot makes an edit and saves the new version of the page.

Currently the bot is ran manually by User:TadeLn. If you need the bot to be ran, you can ask User:TadeLn to do so, by sending a message on Discord, or sending an e-mail via the wiki.

The sections that the bot should edit are indicated manually with markers:

  • <!-- ## RIZBOT BEGIN command_name [arg1 [arg2...]] ## -->, and
  • <!-- ## RIZBOT END command_name ## -->,

where command_name is the type of the section that the bot should generate (for example, rizline_song_info_box, or rizline_song_stats). All command names are described below. Additional space-separated arguments may be added after the section_type in the BEGIN marker.

Warning: It is important to remember that anything that is between the BEGIN and END markers will be overwritten. Manual changes to the content in-between the markers will be lost when the bot will be launched again.

Rizline Song Info Box (rizline_song_info_box)

To generate a song info box using Rizbot, use the following syntax:

<!-- ## RIZBOT BEGIN rizline_song_info_box RizlineLevelID ## -->
<!-- ## RIZBOT END rizline_song_info_box ## -->
  • RizlineLevelID - Internal ID of the level for which to generate the info box.
    • For example: PastelLines.RekuMochizuki.0 - Generate a song info box for Pastel Lines. Used in: Rizline:Pastel Lines.
    • If song data associated with this ID cannot be found, an error will occur.

Rizline Song List (rizline_song_list)

To generate a list of songs using Rizbot, use the following syntax:

<!-- ## RIZBOT BEGIN rizline_song_list ListType ## -->
<!-- ## RIZBOT END rizline_song_list ## -->
  • ListType - One of the values below, indicating the type of the list.
    • all - Generate a list of all songs. Used in: Rizline:List of songs.
    • disc_1 - Generate a list of songs in Disc 1. Used in: Rizline:Disc 1.
    • disc_2 - Generate a list of songs in Disc 2. Used in: Rizline:Disc 2.
    • disc_ex - Generate a list of songs in Disc EX. Used in: Rizline:Disc EX.
    • coin - Generate a list of songs purchasable with coins. Used in: Rizline:Coin.
    • Any other value will cause an error.