OpenTaiko

https://github.com/0aubsq/opentaiko
Admin
OpenTaiko is an open-source Taiko rhythm game player that offers multiple gameplay modes, extensive...
Tokens:13,222
Snippets:173
Trust Score:8.5
License:MIT
Update:2 months ago
Show doc for...
Tokens:
Raw
### Initialize script data

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420201/en.txt

Define the init function to perform setup tasks when the script is first loaded.

```lua
function init()
Called once when the script is loaded. This is used to initialize
important data, including images.
```

--------------------------------

### init()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420201/en.txt

The init function is a lifecycle hook called automatically by the engine when a script is loaded. It is intended for performing setup tasks such as initializing data or loading images.

```APIDOC
## init()

### Description
Called once when the script is loaded. This is used to initialize important data, including images.

### Signature
`void init()`
```

--------------------------------

### Config menu text dictionary indexes

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Documentation/I18N/DictionnaryIndexes.md

A mapping of integer indexes to their corresponding configuration menu labels and descriptions.

```text
# Config menu text (000XX & 100XX)

0 : "System language" description
1 : "System language" option title
2 : "<< Back to left menu" option title
3 : "<< Back to left menu" description
4 : "Reload songs" option title
5 : "Reload songs" description
6 : "Player count" option title
7 : "Player count" description
8 : "Risky" option title
9 : "Risky" description
10 : "Song speed" option title
11 : "Song speed" description
12 : "AI Level" option title
13 : "AI Level" description
14 : "Global offset" option title
15 : "Global offset" description
16 : "Layout type" option title
17 : "Layout type" description
18 : "Time stretch" description
19 : "Full screen mode" description
20 : "Stage failed" description
21 : "Random select affects boxes" description
22 : "VSync mode" description
23 : "AVI playback" description
24 : "BGA playback" description
25 : "Time until preview playback" description
26 : "Time until preview image" description
27 : "Show debug information on down right" description
28 : "Background picture transparency" description
29 : "BGM playback" description
30 : "Save score information" description
31 : "Use BS1770GAIN measured numbers" description
32 : "Set BS1770GAIN loudness meter number" description
33 : "Use .tja files' SONGVOL meter" description
34 : "Sound effect volume" description
35 : "Voice and combo voice volume" description
36 : "Volume in-game (Song playback level)" description
37 : "Keyboard level increment" description
38 : "Time before song start in-game" description
39 : "Auto save results" description
40 : "Discord-RPC toggle" description
41 : "Buffer inputs" description
42 : "Trace log output" description
43 : "Sound output type" description
44 : "WASAPI buffer size" description
45 : "ASIO device" description
46 : "OS timer" description
47 : "Show character image" description
48 : "Show dancer image" description
49 : "Show mob image" description
50 : "Show runner image" description
51 : "Show footer image" description
52 : "Use image processed beforehand (Fast render)" description
53 : "Show petit-character image" description
54 : "Change skin" description
55 : "System key input configuration" description
56 : "Toggle auto play" option title
57 : "Toggle auto play" description
58 : "Toggle auto play for 2P" option title
59 : "Toggle auto play for 2P" description
60 : "Rolls speed" option title
61 : "Rolls speed" description
62 : "Scroll speed" option title
63 : "Scroll speed" description
64 : "Risky" option title
65 : "Risky" description
66 : "Random" option title
67 : "Random" description
68 : "Stealth" option title
69 : "Stealth" description
70 : "No information" option title
71 : "No information" description
72 : "Just" option title
73 : "Just" description
74 : "Tight" option title
75 : "Tight" description
76 : "Minimum number of combo that shows" option title
77 : "Minimum number of combo that shows" description
78 : "Input adjust" option title
79 : "Input adjust" description
80 : "Default difficulty course" option title
81 : "Default difficulty course" description
82 : "Score calculation formula" option title
83 : "Score calculation formula" description
84 : "Shin-uchi toggle" description
85 : "Branch guide" option title
86 : "Branch guide" description
87 : "Branch animation toggle" option title
88 : "Branch animation toggle" description
89 : "Game mode toggle" option title
90 : "Game mode toggle" description
91 : "Big notes with both drum sides" option title
92 : "Big notes with both drum sides" description
93 : "Judge count display" option title
94 : "Judge count display" description
95 : "Key config" option title
96 : "Key config" description
97 : "Capture key" option title
98 : "Capture key" description
99 : "Left red drum key settings" option title
10000 : "Left red drum key settings" description
10001 : "Right red drum key settings" option title
10002 : "Right red drum key settings" description
10003 : "Left blue drum key settings" option title
10004 : "Left blue drum key settings" description
10005 : "Right blue drum key settings" option title
10006 : "Right blue drum key settings" description
10007 : "Left red drum key settings for 2P" option title
10008 : "Left red drum key settings for 2P" description
10009 : "Right red drum key settings for 2P" option title
10010 : "Right red drum key settings for 2P" description
10011 : "Left blue drum key settings for 2P" option title
10012 : "Left blue drum key settings for 2P" description
10013 : "Right blue drum key settings for 2P" option title
10014 : "Right blue drum key settings for 2P" description
10018 : "Time stretch" option title
10019 : "Full screen mode" option title
10020 : "Stage failed" option title
10021 : "Random select affects boxes" option title
10022 : "VSync mode" option title
10023 : "AVI playback" option title
```

--------------------------------

### loadAssets()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

Handles resource allocation for the modal system.

```APIDOC
## loadAssets()

### Description
Method for resource allocation. Called at each skin reload and at application launch.
```

--------------------------------

### Configure SimpleStyle Skin Fonts

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/README.md

Update the Config.ini file to specify the font names used for rendering text in the skin.

```ini
; フォントレンダリングに使用するフォント名
; Font name used for font rendering.
FontName=廻想体 ネクスト UP B

; Boxの説明文のフォントレンダリングに使用するフォント名
; Font name used for font rendering.
BoxFontName=廻想体 ネクスト UP B


; Use " マキナス 4 Square " if you want to use the font used on the skin assets (but letters are wider and more blocky on it)
; Feel free to use only one of those fonts if you don't like one of them (both are blocky, the second one is more standard for English), Kaisoutai contains less kanji than Makinas.
; If you don't like both fonts, keep the default ones (MS Gothic), but keep in mind that the skin is built around the given fonts.
```

--------------------------------

### playAnime()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420211/en.txt

Triggers the difficulty transition animation when a player switches between Extreme and Extra difficulty levels.

```APIDOC
## playAnime()

### Description
This function is invoked when a player switches between Extreme and Extra difficulty levels on the difficulty selection screen. The animation duration for this transition is controlled via the Skin Config files.

### Signature
`void playAnime()`
```

--------------------------------

### Load an image file

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420102/en.txt

Use this function to register an image file for use in subsequent drawing operations. This step is mandatory before any drawing functions can be applied to the image.

```C#
func:AddGraph("filename");
```

--------------------------------

### registerNewModal(player, rarity, modal_type, modal_info, modal_visual_ref)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

Registers a new modal with specific player, rarity, and asset information.

```APIDOC
## registerNewModal(player, rarity, modal_type, modal_info, modal_visual_ref)

### Description
Registers a new modal instance including its related asset information and visual references.

### Parameters
- **player** (int) - The player index (1-5).
- **rarity** (int) - The rarity of the asset (0-6).
- **modal_type** (int) - The type of asset (0: Coins, 1: Character, 2: Puchichara, 3: Title, 4: Song).
- **modal_info** (object) - Asset-specific information based on modal_type.
- **modal_visual_ref** (object) - Asset-specific visual references or extra data.
```

--------------------------------

### draw()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

Handles rendering for displayable modal elements.

```APIDOC
## draw()

### Description
Rendering method called at each result screen Draw() iteration for displayable elements.
```

--------------------------------

### update()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

The regular update loop for modal logic.

```APIDOC
## update()

### Description
Regular update loop used for logic such as incrementing time counters. Executes before the draw() method.
```

--------------------------------

### kusuIn()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420206/en.txt

Triggered when a Kusudama sequence begins.

```APIDOC
## kusuIn()

### Description
Called once when a Kusudama sequence has started.

### Signature
`void kusuIn()`
```

--------------------------------

### List In-Game Texture Credits

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/README.md

A list of sources and contributors for the game's texture assets.

```text
- TJAPlayer3 Default skin (SimpleStyle)
- Freepik (starline / vector_corp / Harryarts) (Patterns)
- cien (@CienpixeL) (Nameplates, Rainbox result screen gauge, Drum textures, End game animations, Gogo splash animations)
- Waldo - https://pressstart.vip/assets (Tower and Dan result screen background and skyboxes)
- PNG Egg (Fireworks) (Non-commercial)
- Takkkom - https://github.com/Takkkom (AI Battle mode and 5P assets)
```

--------------------------------

### Draw an image at specific coordinates

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420103/en.txt

Use this function to render an image file at the specified x and y coordinates.

```text
func:DrawGraph(x, y, "filename");
```

--------------------------------

### AddGraph(filename)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420102/en.txt

Loads an image file into the script environment, which is a mandatory step before performing any drawing operations with that image.

```APIDOC
## AddGraph(filename)

### Description
Loads an image file to be used for your script. This is mandatory for drawing functions to work on your image.

### Signature
`void AddGraph(string filename)`

### Parameters
- **filename** (string) - Required - The path or name of the image file to load.
```

--------------------------------

### Development Credits List

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/README.md

A list of primary developers and contributors who have implemented features, bug fixes, and dependency removals.

```text
Main developers : 0AuBSQ - https://github.com/0auBSQ/OpenTaiko and Takkkom - https://github.com/Takkkom
Multiple additionnal features, mainly VTT lyrics support : DragonRatTiger - https://github.com/DragonRatTiger
Several bug fixes and improvements : l1m0n3 - https://github.com/l1m0n3
Complete removal of the SlimDX dependency : Mr-Oiji https://github.com/Mr-Ojii
Mod icons : FAKEYJSNPI - https://github.com/FAKEYJSNPI
```

--------------------------------

### gogo

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420308/en.txt

Retrieves the current Go-Go Time status for all players.

```APIDOC
## gogo

### Description
Returns a list of boolean values indicating whether Go-Go Time is currently active for each player.

### Returns
- **List<boolean>** - A list where each index corresponds to a player, containing true if Go-Go Time is active, false otherwise.
```

--------------------------------

### fps

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420301/en.txt

A global variable that returns the current frames per second of the application.

```APIDOC
## fps

### Description
Gets the current frames per second (FPS) of the application.

### Type
Number
```

--------------------------------

### local bpm

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420305/en.txt

Retrieves a list of non-integral BPM values for each player, reflecting the current BPM of their respective charts.

```APIDOC
## local bpm

### Description
Retrieves a list of non-integral values representing the current BPM for each player's chart. Note that BPM values can differ between players.

### Usage
This function returns a list where each element corresponds to the current BPM of the chart being played by the respective player.
```

--------------------------------

### SetOpacity(opacity, filename)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420108/en.txt

Sets the opacity level of a specified image file. The opacity value is an integer ranging from 0 to 255.

```APIDOC
## SetOpacity(opacity, filename)

### Description
Sets the opacity of a given image. The value must be between 0 and 255.

### Parameters
- **opacity** (int) - Required - The opacity level, ranging from 0 to 255.
- **filename** (string) - Required - The name of the image file to modify.
```

--------------------------------

### Registering a new modal

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

Defines the arguments required for the registerNewModal method, including player ID, rarity, modal type, and associated asset information.

```text
- (int) player: The player related to the modal (between 1 and 5)
- (int) rarity: The rarity of the unlocked asset (between 0 (Poor) and 6 (Mythical)), unused for Coins
- (int) modal_type: The type of unlocked asset (0: Coins, 1: Character, 2: Puchichara, 3: Title, 4: Song)

- (object) modal_info:  Asset related information, modal_type dependent:
> Coins -> (long) modal_info: The coin value of the play
> Character -> (CCharacter) modal_info: The unlocked character information data (never nil) 
> Puchichara -> (CPuchichara) modal_info: The unlocked puchichara information data (never nil)
> Title -> (NameplateUnlockable) modal_info: The unlocked nameplate information data (never nil)
> Song -> (SongNode?) modal_info: The unlocked song information data (can be nil)

- (object) modal_visual_ref:  Asset related visuals (or extra info), modal_type dependent:
> Coins -> (long) modal_visual_ref: The total count of coins after the play
> Character -> (CTexture?) modal_visual_ref: The character render as displayed in my room (can be nil)
> Puchichara -> nil
> Title -> (LuaNamePlateScript) modal_visual_ref: A reference to the Nameplate Lua script (never nil except if broken skin)
> Song -> (CTexture?) modal_visual_ref: The song preimage, with the size value set to the same value as in the song select menu (can be nil)
```

--------------------------------

### kusuBroke()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420206/en.txt

Triggered when a Kusudama sequence is successfully cleared.

```APIDOC
## kusuBroke()

### Description
Called once when a Kusudama was successfully cleared.

### Signature
`void kusuBroke()`
```

--------------------------------

### playEndAnime(player)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420209/en.txt

This function is invoked when a player finishes a course. It receives the player ID as an argument and can be executed multiple times within a single frame.

```APIDOC
## function playEndAnime(player)

### Description
Called once when a course is finished. This function is used to trigger ending animations for a specific player.

### Parameters
- **player** (int) - Required - The player ID that is qualified to run this script.
```

--------------------------------

### Draw a centered image at specific coordinates

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420103/en.txt

Use this function to render an image file centered at the specified x and y coordinates.

```text
func:DrawGraphCenter(x, y, "filename");
```

--------------------------------

### local lang

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420302/en.txt

Retrieves the current language setting of the application as a short string identifier.

```APIDOC
## local lang

### Description
Gets the current selected language as a short string format (e.g., "en", "ja", "fr").

### Returns
- **language** (string) - The current language code.
```

--------------------------------

### battleState

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420310/en.txt

Retrieves the current state of the active AI Battle as an integer value.

```APIDOC
## battleState

### Description
Returns an integer representing the current state of the active AI Battle. The value ranges from -9 to 9, where 0 is the default.

### Return Value
- **Integer**: A value between -9 and 9. Zero or higher indicates the player is winning, while a lower number indicates the AI is winning.
```

--------------------------------

### Define playEndAnime function

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420209/en.txt

This function is called once when a course is finished, accepting a player ID as an argument.

```lua
function playEndAnime(player)
```

--------------------------------

### battleWin

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420311/en.txt

Retrieves the current win status of the player against the AI in an AI Battle session.

```APIDOC
## battleWin

### Description
Returns a boolean value indicating whether the player is currently winning or has already won against the AI in an AI Battle. This method is intended for use within the Results Screen menu.

### Returns
- **boolean** - True if the player is winning or has won, false otherwise.
```

--------------------------------

### Apply Multiply filter with SetColor

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420109/en.txt

Use this function to recolor images by providing RGB values between 0 and 1 and the target filename.

```text
func:SetColor(r, g, b, "filename");
```

--------------------------------

### DrawText(x, y, text)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420101/en.txt

Draws a string of text to the screen using the skin's Console Font.

```APIDOC
## DrawText(x, y, text)

### Description
Draws text to the screen using the skin's Console Font (\Graphics\Console_Font.png). Only Basic Latin unicode characters are supported.

### Parameters
- **x** (number) - The horizontal coordinate.
- **y** (number) - The vertical coordinate.
- **text** (string) - The text string to display.
```

--------------------------------

### Set Image Blend Mode

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420110/en.txt

Defines the blending behavior for an image. Supported modes include Normal, Add, Multi, Sub, and Screen.

```text
func:SetBlendMode("mode", "filename");
```

--------------------------------

### SetScale(xscale, yscale, filename)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420106/en.txt

Sets the scale of a specified image. The default scale value is 1.

```APIDOC
## SetScale(xscale, yscale, "filename")

### Description
Sets the scale of the specified image. The default scale value is 1.

### Parameters
- **xscale** (number) - Required - The horizontal scaling factor.
- **yscale** (number) - Required - The vertical scaling factor.
- **filename** (string) - Required - The path or name of the image file to scale.
```

--------------------------------

### Define playAnime function

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420211/en.txt

This function is invoked when a player switches between Extreme and Extra difficulty levels.

```javascript
function playAnime()
```

--------------------------------

### DrawNum(x, y, num)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420101/en.txt

Draws a number to the screen using the skin's Console Font.

```APIDOC
## DrawNum(x, y, num)

### Description
Draws a number to the screen using the skin's Console Font (\Graphics\Console_Font.png).

### Parameters
- **x** (number) - The horizontal coordinate.
- **y** (number) - The vertical coordinate.
- **num** (number) - The numeric value to display.
```

--------------------------------

### SetRotation(rotation, filename)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420107/en.txt

Sets the rotation of a specified image file.

```APIDOC
## SetRotation(rotation, filename)

### Description
Sets the rotation of your image. The rotation value is typically between 0 and 360.

### Parameters
- **rotation** (number) - Required - The degree of rotation to apply (typically 0-360).
- **filename** (string) - Required - The path or name of the image file to rotate.
```

--------------------------------

### p1IsBlue

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420304/en.txt

Retrieves a boolean value indicating if Player 1 is set to blue. This is determined by the player selecting 'Right' in the title menu.

```APIDOC
## p1IsBlue

### Description
Returns a boolean indicating if Player 1 is currently set to blue. This state is triggered by selecting 'Right' in the title menu. Note that this is only applicable for 1P mode; it returns false if the player is not blue or if there are 2 or more players active.

### Returns
- **boolean** - True if Player 1 is blue, false otherwise.
```

--------------------------------

### skipAnime()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420210/en.txt

This function is triggered when a player skips the animation on the Results screen.

```APIDOC
## skipAnime()

### Description
Called once when any player skips the Results screen animation.

### Signature
void skipAnime()
```

--------------------------------

### List Original Soundtrack Credits

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/README.md

A list of tracks, artists, and chart creators for the OpenTaiko original soundtrack.

```text
001 - cityscape : Makotora - https://soundcloud.com/xoxomakotora | Makotora#0001 (Chart by Makotora)
002 - Zerstören : Sukima Altera - https://youtube.com/c/SukimaAltera | https://www.twitter.com/SukimaAltera (Chart by bol (Except Hard) : https://drive.google.com/drive/folders/1xESVf820-iIxnyEtRq7liqmC_0zCZGJA)
003 - Breaking Point : Yonokid - https://youtube.com/channel/UCQmfYbGGEaz-LMcFf6bNT_Q | https://twitter.com/yonokid (Chart by bol : https://drive.google.com/drive/folders/1kocNOQrdsgKHjHTjMTAKPnHh7-WpNzDJ)
004 - Deceiving the Deceiver : H5 - https://linktr.ee/H5Music (Chart by 0AuBSQ & bol)
005 - WTF?! : Moox - https://soundcloud.com/themoox/wtf (Chart by Moox & bol)
006 - Athazagoraphobia : Derpikarp - https://youtube.com/channel/UCrURywBu-fDA5KQaDPc3GOg (Chart by Colin & bol)
007 - Gewissenbisse : Sukima Altera vs ALTERNATiVE THEORY - https://youtube.com/c/SukimaAltera | https://www.twitter.com/SukimaAltera (Chart by 0AuBSQ)
008 - DON'T LOOK BACK : TFD500 - https://www.youtube.com/channel/UCJjrxomZT2973fr8-9Yts_w (Chart by bol)
009 - Deceiver : H5 - https://linktr.ee/H5Music (Chart by 0AuBSQ)
010 - BassBoL : InterChan - https://www.youtube.com/c/InterChan374 (Chart by bol)
011 - Liberation : DeBisco - https://soundcloud.com/debisco | https://twitter.com/debiscomusic (Chart by Colin & 0AuBSQ & bol)
012 - Deceiver's Terminus : H5 - https://linktr.ee/H5Music (Chart by 0AuBSQ)
013 - Corrupted Angel : TFD500 - https://www.youtube.com/channel/UCJjrxomZT2973fr8-9Yts_w (Chart by bol)
014 - Startup Parade! : Ryuto Setsujin - https://youtube.com/c/ArGameOfficial (Chart by bol)
015 - White Heart : 9C feat. Cusi - https://youtube.com/channel/UCxx3wiFJxGwb_-tEePPa4RA (Chart by bol)
016 - Summer Overload! : Akako Hinami - https://soundcloud.app.goo.gl/nnjSb (Chart by bol)
017 - Halcyon : Akako Hinami - https://soundcloud.app.goo.gl/nnjSb (Chart by bol)
018 - Chasing the Wind : DashyDesu - https://www.youtube.com/c/DashyDesu (Chart by DashyDesu & bol)
019 - Back Where I'm From : NetroAki - https://soundcloud.com/netroaki | https://twitter.com/netroaki | https://instagram.com/netroaki | https://netroaki.audio/ (Chart by 0AuBSQ)
020 - Slayer of. : Aden Mayo - https://www.youtube.com/channel/UCXEd-dVZGZDf6plBmGd8cig (Chart by bol)
021 - Welcome To The Cafe : Sukima Altera feat. ALTERNATiVE THEORY - https://youtube.com/c/SukimaAltera | https://www.twitter.com/SukimaAltera (Chart by 0AuBSQ)
022 - Seismic Shake : DeBisco - https://soundcloud.com/debisco | https://twitter.com/debiscomusic (Chart by 0AuBSQ & bol)
023 - Stereotype : Taichenko - https://space.bilibili.com/356518101 (Chart by Taichenko (Extreme) & 0AuBSQ (Easy, Normal, Hard))
024 - Rainy Night ~夢幻想~ : Taichenko - https://space.bilibili.com/356518101 https://b23.tv/LBMw5Oz (Chart by Taichenko (Extreme) & 風に乗ってgo (Easy, Normal, Hard))
025 - Fearless : Ash Electric - https://linktr.ee/ashelectric (Chart by 0AuBSQ)
026 - Lost Emotion. : DashyDesu - https://www.youtube.com/c/DashyDesu (Chart by DashyDesu)
027 - Broken Metronome : DashyDesu - https://www.youtube.com/c/DashyDesu (Chart by DashyDesu (Extreme, Extra) & 0AuBSQ (Easy, Normal, Hard))
028 - Katharsis : 9C - https://youtube.com/channel/UCxx3wiFJxGwb_-tEePPa4RA (Chart by 0AuBSQ)
029 - 2-Steppin' Love : FUNKYZUKIN ft. Hatsune Miku - https://funkyzukin.bandcamp.com/album/2-steppin-love-single (Chart by colin, Extra by 0AuBSQ)
030 - 闇 : TFD500 - https://www.youtube.com/channel/UCJjrxomZT2973fr8-9Yts_w (Chart by bol)
```

--------------------------------

### Define the draw function

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420208/en.txt

This function is called every frame for each player ID qualified to run the script.

```lua
function draw(player)
```

--------------------------------

### Set Image Scale

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420106/en.txt

Adjusts the horizontal and vertical scale of a specified image file. The default scale value is 1.

```text
func:SetScale(xscale, yscale, "filename");
```

--------------------------------

### clearIn(player)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420204/en.txt

The clearIn function is called when a player reaches the clear range. It accepts a player ID as an argument to identify which player triggered the event.

```APIDOC
## clearIn(player)

### Description
Called once when a player has reached the clear range.

### Parameters
- **player** (integer) - Required - The player ID that has entered the clear range. Values range from 0 to 4 (0 for 1P, 1 for 2P, 2 for 3P, etc.).
```

--------------------------------

### DrawGraph

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420103/en.txt

Draws a specified image file at the given x and y coordinates.

```APIDOC
## DrawGraph(x, y, "filename")

### Description
Draws a given image at a specified position.

### Parameters
- **x** (int) - The horizontal coordinate.
- **y** (int) - The vertical coordinate.
- **filename** (string) - The path or name of the image file to draw.
```

--------------------------------

### Calculate towerNightNum

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420309/en.txt

Determines the progression value based on the current measure and the maximum floor count of the tower.

```C#
Math.Min(CurrentMeasure / Math.Max(140, MaxFloorCount / 2), 1);
```

--------------------------------

### SetColor(r, g, b, filename)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420109/en.txt

Applies a Multiply filter to the specified image file using the provided RGB color values.

```APIDOC
## SetColor(r, g, b, filename)

### Description
Applies a Multiply filter to an image to recolor it based on the provided RGB values.

### Parameters
- **r** (float) - Required - Red color component (0.0 to 1.0)
- **g** (float) - Required - Green color component (0.0 to 1.0)
- **b** (float) - Required - Blue color component (0.0 to 1.0)
- **filename** (string) - Required - The path or name of the image file to process
```

--------------------------------

### Translation Credits List

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/README.md

A list of contributors responsible for translating the project into various languages.

```text
Spanish : funnymoth - https://github.com/funnym0th
English : Meowgister - https://www.youtube.com/channel/UCDi5puZaJLMUA6OgIAb7rmQ
Chinese : WHMHammer - https://github.com/WHMHammer
```

--------------------------------

### Set Image Rotation

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420107/en.txt

Sets the rotation of an image using a specified degree value and filename.

```text
func:SetRotation(rotation, "filename");
```

--------------------------------

### local gauge

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420306/en.txt

Retrieves the current soul gauge values for all players.

```APIDOC
## local gauge

### Description
Gets a list of integers between 0-100 for each player that represent their current position on the soul gauge.

### Returns
- **List<Integer>** - A collection of integers (0-100) representing the soul gauge level for each player.
```

--------------------------------

### Define update function for ending animations

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420207/en.txt

This function is called every frame for each player ID qualified to run the script.

```lua
function update(player)
```

--------------------------------

### kusuMiss()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420206/en.txt

Triggered when a Kusudama sequence fails to clear.

```APIDOC
## kusuMiss()

### Description
Called once when a Kusudama has failed to clear before the sequence has ended.

### Signature
`void kusuMiss()`
```

--------------------------------

### isClear

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420307/en.txt

Retrieves a list of boolean values indicating whether each player has cleared their current course.

```APIDOC
## isClear

### Description
Returns a list of booleans representing the clear status for each player in the current session.

### Returns
- **List<Boolean>** - A collection of boolean values where true indicates the player has cleared the course.
```

--------------------------------

### DrawGraphCenter

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420103/en.txt

Draws a specified image file centered at the given x and y coordinates.

```APIDOC
## DrawGraphCenter(x, y, "filename")

### Description
Draws a given image at a position, centered at the given coordinates.

### Parameters
- **x** (int) - The horizontal center coordinate.
- **y** (int) - The vertical center coordinate.
- **filename** (string) - The path or name of the image file to draw.
```

--------------------------------

### Skip Results Screen Animation

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420210/en.txt

This function is invoked when a player skips the results screen animation.

```lua
function skipAnime()
Called once when any player skips the Results screen animation.
```

--------------------------------

### Define clearIn function

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420204/en.txt

This function is called automatically when a player enters the clear range. The player parameter represents the player ID, ranging from 0 to 4.

```lua
function clearIn(player)
```

--------------------------------

### isAnimationFinished()

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/System/Open-World Memories/Modules/Modal/README.md

Checks if the current modal animation has completed.

```APIDOC
## isAnimationFinished()

### Description
Returns a boolean indicating if the currently playing modal animation is finished. When true, the enter key is enabled to proceed to the next modal or return to the song select screen.

### Returns
- **(bool)** - True if animation is finished, false otherwise.
```

--------------------------------

### Draw an image with DrawGraphRectCenter

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420105/en.txt

Use this function to render a specific rectangular area of an image centered at the provided x and y coordinates. If the rectangle exceeds image boundaries, the texture will repeat.

```C#
func:DrawGraphRectCenter(x, y, rect_x, rect_y,
	rect_width, rect_height, "filename");
```

--------------------------------

### Draw a rectangular portion of an image

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420104/en.txt

Use this function to render a specific area of an image file at a designated coordinate. If the specified rectangle exceeds image dimensions, the texture will repeat.

```C#
func:DrawRectGraph(x, y, rect_x, rect_y,
	rect_width, rect_height, "filename");
```

--------------------------------

### SetBlendMode

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420110/en.txt

Sets the blending mode for an image relative to the background.

```APIDOC
## SetBlendMode("mode", "filename")

### Description
Specifies how an image should blend into the background.

### Parameters
- **mode** (string) - Required - The blending mode to apply. Options: "Normal", "Add", "Multi" (Multiply), "Sub" (Subtract), "Screen".
- **filename** (string) - Required - The identifier or filename of the image to apply the blend mode to.
```

--------------------------------

### draw(player)

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420208/en.txt

A function called every frame during the ending animation to handle custom image manipulation and drawing for specific players.

```APIDOC
## function draw(player)

### Description
Called every frame during the ending animation. This function is used for manipulating and drawing images, and is executed for each player ID qualified to run the script.

### Parameters
- **player** (object) - Required - The player instance associated with the current execution context.

### Usage
This function can be invoked multiple times in a single frame depending on the number of qualified players.
```

--------------------------------

### deltaTime

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420301/en.txt

A global variable that returns the time elapsed since the last frame in seconds.

```APIDOC
## deltaTime

### Description
Gets the amount of time that has passed since the last frame was drawn. The value is non-integral and measured in seconds (e.g., 0.0166666...).

### Type
Number (Seconds)
```

--------------------------------

### Define clearOut function

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420205/en.txt

This function is invoked automatically when a player drops out of the clear range. The player parameter represents the unique ID of the player who triggered the event.

```lua
function clearOut(player)
Called once when a player has dropped from the clear range.
The player value is the player ID that has dropped from the
clear range.
```

--------------------------------

### DrawGraphRectCenter

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420105/en.txt

Draws a specified rectangular portion of an image centered at the provided coordinates.

```APIDOC
## DrawGraphRectCenter(x, y, rect_x, rect_y, rect_width, rect_height, filename)

### Description
Draws a given image at a position, centered at the given coordinates. A rectangle is used to specify what portion of the image to draw. If the rectangle exceeds the image bounds, it will loop to repeat the texture.

### Parameters
- **x** (float) - The center X coordinate on the screen.
- **y** (float) - The center Y coordinate on the screen.
- **rect_x** (int) - The X coordinate of the top-left corner of the source rectangle.
- **rect_y** (int) - The Y coordinate of the top-left corner of the source rectangle.
- **rect_width** (int) - The width of the source rectangle.
- **rect_height** (int) - The height of the source rectangle.
- **filename** (string) - The path or identifier of the image file.
```

--------------------------------

### DrawRectGraph

Source: https://github.com/0aubsq/opentaiko/blob/main/OpenTaiko/Encyclopedia/Pages/420104/en.txt

Draws a specified rectangular portion of an image at a given coordinate. If the rectangle exceeds the image bounds, the texture will loop.

```APIDOC
## DrawRectGraph

### Description
Draws a given image at a specified position using a rectangle to define the source area. This method supports texture repeating if the rectangle dimensions exceed the source image bounds.

### Signature
`DrawRectGraph(x, y, rect_x, rect_y, rect_width, rect_height, "filename");`

### Parameters
- **x** (int) - The x-coordinate on the screen to draw the image.
- **y** (int) - The y-coordinate on the screen to draw the image.
- **rect_x** (int) - The x-coordinate of the top-left corner of the source rectangle.
- **rect_y** (int) - The y-coordinate of the top-left corner of the source rectangle.
- **rect_width** (int) - The width of the source rectangle.
- **rect_height** (int) - The height of the source rectangle.
- **filename** (string) - The path or identifier of the image file to draw.
```
Tokens:
Raw