Average4K information, all in one place.
WE LOVE KADE DEV HAHAHAHAHAHAHA
NOTE: All information stored is in the Wiki tab.
When looking at code samples, remember that your lua file must still be named mod.lua, and that you cannot have more than one lua file.
If you want a good source on how to learn lua, here's the Official Lua Documentation website.
For people who aren't currently beta testers, wishlist the game!
Check out the current progress on the Trello Page!
Join the Discord Server for better announcements from Kade himself!
These are all the people who have worked on this document, helping by adding information:
Burger Gaming (Mods)
tylersfoot (Skinning)
If you want to become a contributor, either by making a code-sample you deem useful, or by adding information to the wiki, make a pull request!
Create the modchart by going into the chart's folder, adding a folder called mod, and putting mod.lua in the folder.
function create()
end
function update()
end
Do you have a song, and you have a chart, but you don't know where to put it? It's pretty easy to do so. This page is dedicated to the process of doing such.
Go to the Average4k directory by right clicking on the game and clicking Manage. After that, click Browse local files.
You should now be in the game's directory. Click on the folder labeled assets, and then charts. Make a new folder, you can name it anything you want.
For each song in your pack, make another folder inside of it and put your chart in that folder.
Go back to the main pack folder you made and make a file called pack.meta.
Open the file in a text editor of your choice, and put in the following code:
packName: [Insert your own pack name]
There are two optional parameters to your song/pack.
showName - Hides the pack name on the pack selection menu.
banner - The path to a custom banner that appears on the left side of the screen on the pack selection menu. It is recommended to set showName to false for this. Make sure it is in the same folder as the pack file.
If you've done it correctly, you should now see your custom pack in the menu.
Mods are special effects you can enable in a modchart. You can adjust the intensity, speed, and easing of a mod.
Below are the mods that you can currently use as of Average4k b11.2.3.
These mods affect all columns in gameplay.
These mods are activated using activateMod(modName, beat, beatLength, easing, amount)
modName - The name of the mod.
beat - The time the mod begins in beats.
beatLength - The amount of time in beats it takes to tween to the amount.
easing - The ease function used to tween to the amount. For a list of easings, use this link. Make sure this value is all lowercase.
amount - The amount the value tweens to. The way this works varies between mods, so be careful.
These mods affect certain columns.
These mods are activated using activateModMap(modName, beat, beatLength, easing, amount, col)
modName - Same as above. Make sure the column-specific variant is being used here.
beat - Same as above.
beatLength - Same as above.
easing - Same as above.
amount - Same as above.
col - Which column you're applying the mod to. 0 is left, 1 is down, 2 is up, 3 is right.
All mods will display their column-specific variant next to the name like this. If there is no column specific variant, it is not available.
Affects the X-axis and waviness of the notes as they travel up.
Click here to see the example video.
Affects the Y-axis. Columns move up and down.
Click here to see the example video.
Receptors and notes rotate. Unlike other mods, the amount is the angle the notes rotate to.
Click here to see the example video.
Moves all notes in a wave-like action across the Y-axis. It is recommended that this should be used for slower scroll speeds.
Click here to see the example video.
Rotates the notes depending on how far they are.
Click here to see the example video.
Moves the playfield along the X-axis.
Same as amovex, but it moves the playfield along the Y-axis.
Scales the playfield. Set to 0.5 by default. 1 is half the size and 0 is double of the current size.
This mod is only available on column-specific mods.
Reverses the column's scrollspeed.
This mod is only available on column-specific mods.
Stealth is a mod that has multiple properties that can be adjusted.
For an example of stealth, click here.
The following are:
Sets a column's transparency.
Sets how white a column is.
Same as stealthOpacity, but only affects the receptor of the column.
config.downscroll - The player setting for downscroll.
config.noteSize - The player setting for note scaling.
setScrollSpeed(speed) - Self explanatory.
setNoteSkin(skin) - Changes the noteskin. Noteskins added to modcharts must be added in the folder the modchart is in.
Skins visually change different aspects of the game, most notably the notes/receptors and the menu.
Below is a basic tutorial on how to create a skin in Average4k as of update b11.2.3.
To create a skin, navigate to the Average4k folder from steam (Average4k->Settings->Manage->Browse local files), then go to assets\noteskin. In here is where all of the skins (including the default ones) are located.
From here, make a copy of one of the default skins, and rename it to whatever you like. You can now change all of the note images and edit the config.skin file, explained below.
This file holds some configuration options to change when creating your skin.
rotate (true/false) - Rotates the sprite's orientation depending on it's direction; Useful for arrow skins.
shrink (true/false) - Shrinks the receptors depending on if they are being held or not.
bounce (true/false) - Makes the combo and judgement text bounce when a note is played.
disableQuant (true/false) - Disables the note color quantization. If set to true, specify the image file to use for each lane. An example is shown below, where the directions specify the notes and the text following it specifies the image file name, without the extension.
left: image1
down: image2
up: image2
right: image1
The final option in config.skin is path.
When set to path: default , the skin will take the default menu elements from the base game. In order to change the menu elements, follow the steps below:
- In the
assetsfolder, copy the entireskinDefaultsfolder. - Paste the folder in your custom skin folder, and rename it to whatever you want (I'll use
skinAssetsfor the sake of this tutorial) - In
config.skin, change the path to the name of the folder (path: skinAssets) - Skin the menu! All changes made to the images in this folder will apply to your game when your skin is selected.
=======
When looking at code samples, remember that your lua file must still be named
mod.lua, and that you cannot have more than one lua file.