Skip to content

Commit

Permalink
The Guides are completed YAYYY!
Browse files Browse the repository at this point in the history
  • Loading branch information
CamLikesKirby committed May 31, 2024
1 parent 483262d commit 9e14122
Show file tree
Hide file tree
Showing 12 changed files with 281 additions and 3 deletions.
Empty file removed mods/readme.txt
Empty file.
1 change: 1 addition & 0 deletions mods/readmeformodding.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Before you go to the guides folder in the test folder make to copy the test folder and rename it.
8 changes: 6 additions & 2 deletions mods/test/data/FreeplaySettings.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"skipSelect": [],
"skipSelect": [
"your-song-here",
"your-song-here-two"
],
"noExtraKeys": [
"test"
"test",
"your-song-here"
]
}
20 changes: 19 additions & 1 deletion mods/test/data/characterSelect.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,25 @@
"notestyle": "3D"
}
],
"mainName": "testtwo",
"mainName": "Bandu Example",
"mainnotems": [1, 1, 1, 1]
},
{
"newCharacter": [
{
"playername": "bf-pixel",
"thecharactername": "Example 2",
"thenotems": [1, 1, 1, 1],
"notestyle": ""
},
{
"playername": "bf-pixel",
"thecharactername": "Example 3",
"thenotems": [1, 1, 1, 1],
"notestyle": ""
}
],
"mainName": "BF Pixel Example",
"mainnotems": [1, 1, 1, 1]
}
]
Expand Down
6 changes: 6 additions & 0 deletions mods/test/guides/! How 2 Get Started.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

First, if you haven't already, copy the test folder and rename it as you like. (It will appear as the Freeplay pack name.)

You can change the icon and the description to your liking.

Make sure to select the mod by pressing 'm' on the title screen.
15 changes: 15 additions & 0 deletions mods/test/guides/How 2 Add Credits.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
First off in data folder go to the charts folder and create a txt file named yoursong-settings

Example:

credit the people who made the song:theHeading:The credit text



To make a image of the song creator(s) go to images\songCreators

copy the example image and edit it with the song creator(s) icons make sure it's named like the credit pop up

you can make a custom heading too by going to images\songHeadings

Copy the example image and edit it make sure it's the same name as the heading you chosen or you can take a heading that is already in the asstes like bambiHeading
14 changes: 14 additions & 0 deletions mods/test/guides/How 2 Add Custom Dialogue.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
First go to data\dialogue

create a txt file and make it the same name of the song you want to add Dialogue to

Example of dialogue:

:bf:Hello I am BF
:bambi:I am bambi
:bambi,upset:I'm mad
:bambi,annoyed:I am every mad
:dave:I am dave!
:dave,scared:Nah what's happening
setfont_code:dave,3d-scared: Oh no I'm 3d and taking werid fisfjsdfodsfsod
setfont_normal:dave:Nvm I'm back
72 changes: 72 additions & 0 deletions mods/test/guides/How 2 Make Custom Characters.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
JSON:

First, go to the data folder, then the characters folder. You should see an example character (Bandu). Copy it and rename it to your character's name, ensuring it does not contain any uppercase letters. open your xml file and rename the
anim like this:

"animName": "singUP",
"anim": "xmlup",
"fps": 24,
"loop": false
},
{
"animName": "singLEFT",
"anim": "xmlleft",
"fps": 24,
"loop": false

and so on

The global offset changes the character's X and Y positions.

To make the character playable, you need an offset file named like this: charactername-playable (We will explain the offsets later).

Skins are for things like the 3D segment (Polygonized) and in Recursed when you miss too many letter notes. This is what you should put in the skin array if you want skins:

{
"type": "3d",
"replacement": "charnamehere"
},
{
"type": "recursed",
"replacement": "charnamehere"
}

bar color just changes the characters bar color

nativelyPlayable flips the left and right sides of the character.

Graphic Size has three options

furiosityScale (For small 3d characters)

daPixelZoom (For Pixel Characters)

Or you can just type in a number

for effect also has there options

3dfloat (Gives the character 3d notes and makes them float)

float (Just makes the character float)

3d (Just gives them 3d notes)

put your json name in customCharacterList txt file

IMAGES AND OFFSETS:

When you're done, go to the images folder and select the characters folder. Put your spritesheet and XML file in there (they both must be named the same as the JSON).

Next, go to the icons folder and put your icons (make sure they are named the same as the JSON).

Then, go to the offset folder, copy the example file, and rename it to the JSON name.

If you selected isPlayable for the JSON, create another text file named jsonname-playable.

now go in the game and select your character from the chart menu

Now, go into the game and select your character from the chart menu. If the positions are off, edit the globalOffset and the text file.

and you should be done!

(For putting your character in the character select, go to the "How 2 put characters in character select" txt file.)
32 changes: 32 additions & 0 deletions mods/test/guides/How 2 Make Custom Dialogue Characters.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
This System is kinda unstable right now so before I tell you how to add custom dialogue characters I will teach you how to do it in a alternative way

so just do this

:generic: Bambi OC: I am bambi oc lolololol
:generic: Dave OC: I am dave oc wait I don't exist

(Make sure you don't put the name of the character near the : if your doing charactername:)

But if you stil want to use custom dialogue characters then follow this:

go to data\characters\dialogue

copy the test json make rename it to anything you like

the x and y don't do anything for something yet so just set right to true

now go to images\dialogue

copy the test folder and rename to your json name

make sure to edit the image name like this

jsonname_normal

you can make more expressions just make sure it's formatted like this:

jsonname_expression

in dialogue to use your custom character do this:

:jsonname,expression: I am custom character
39 changes: 39 additions & 0 deletions mods/test/guides/How 2 Put Characters in Character Select.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
First off go to data open the characterSelect json

it should have a example of a character and a character with different forms

you can replace it with this:
{
"characters": [
{
"newCharacter": [
{
"playername": "nameofchar",
"thecharactername": "Name of Char in Character Select Menu",
"thenotems": [1, 1, 1, 1],
"notestyle": "3D or just put nothing"
}
],
"mainName": "Will be the name if you get a highscore with the character",
"mainnotems": [1, 1, 1, 1]
}
]
}

you can add more characters by doing this replacing the last curly bracket (}):

},
{
"newCharacter": [
{
"playername": "nameofchar",
"thecharactername": "Name of Char in Character Select Menu",
"thenotems": [1, 1, 1, 1],
"notestyle": "3D or just put nothing"
}
],
"mainName": "Will be the name if you get a highscore with the character",
"mainnotems": [1, 1, 1, 1]
}
]
}
5 changes: 5 additions & 0 deletions mods/test/guides/How 2 Set Up Freeplay Settings.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
In the data folder open up FreeplaySettings

you should see two arrays one named skipSelect and one named noExtraKeys

there are already examples in the json file
72 changes: 72 additions & 0 deletions mods/test/guides/How 2 add Custom Songs.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
First go to charts and put your chart there (make sure to only have the song name)

if your going to have a extra key difficulty as well do this:

songname-extrakeys

Now put your inst and voices into the songs folder (Make sure that files are oggs and they are in a folder that is your song name)

For Freeplay:

Go to data and select customSongs.txt

delete the test song if you want to and replace it with this:

yoursong:1:characternameforicon

you can put multiple to by doing this:

yoursong:1:characternameforicon
yoursong:1:characternameforicon
yoursong:1:characternameforicon

The number is a array from 0 to 16:

var songColors:Array<FlxColor> = [
0xFF00137F, // GF but its actually dave!
0xFF4965FF, // DAVE
0xFF00B515, // MISTER BAMBI RETARD (thats kinda rude ngl)
0xFF00FFFF, // SPLIT THE THONNNNN
0xFF800080, // FESTIVAL
0xFF116E1C, // MASTA BAMBI
0xFFFF0000, // KABUNGA
0xFF0EAE2C, // SECRET MOD LEAK
0xFFFF0000, // TRISTAN
FlxColor.fromRGB(162, 150, 188), // PLAYROBOT
FlxColor.fromRGB(44, 44, 44), // RECURSED
0xFF31323F, // MOLDY
0xFF35396C, // FIVE NIGHT
0xFF0162F5, // OVERDRIVE
0xFF119A2B, // CHEATING
0xFFFF0000, // UNFAIRNESS
0xFF810000, // EXPLOITATION
];

Now your song is playable (open up the chart editor to edit the characters and the stage)

Story Mode:

In the data folder open up weeks.json

you put your songs into the songlist array

the week name is what shows up as a desc of your custom week

the weekBanner is the name of your .png banner in images\weekBanners

in images\storymenu make sure your first custom week is named week6 and the other one week7 and so on

to add more weeks replace the last curly bracket (}) with this:

},
{
"songList": ["Test", "Test"],
"weekName": "Test Week",
"bannerName": "testbanner"
}
]
}




0 comments on commit 9e14122

Please sign in to comment.