So, you wanna post a mod you've made? Submissions is where it goes!
When you post mods in Addons & More, a corresponding thread is created here. A judge will check your mod, and if it follows all rules and guidelines, then the mod will be approved, and its thread will be moved into its proper place in Addons & More Discussion. If there is something wrong that needs to be corrected, then a judge will inform you of what needs to be done. Once you've made the requested changes, you must re-submit your mod, and it will be evaluated again. If you don't meet the requirements or continue to not follow the instructions given, then your mod will be moved to Rejected Submissions.
You can only see your own submissions, and only judges and moderators can see all the submissions. Submissions will remain hidden until they are moved to Addons & More.
Addons that do not follow these guidelines will most likely be rejected. However that doesn't always mean you cannot share them on the MS or in the community.
Please refer to the Message Board Rules, Discord Server Rules, or the Master Server Hosting Rules to know what is and is not allowed on each platform.
If you are confused, please contact the Staff responsible for the platforms you need support with.
Mod Submission Rules
- Message board rules apply to all submissions, particularly concerning bigoted or inappropriate content.
- Example: If your file contains pornographic content, it will be rejected.
- File names must conform to Filename Conventions.
- Example: A file named “myzone.pk3” will not pass, but a file named “SL_myzone_v1.pk3” may pass.
- Your submission must have a good chunk of content that you created yourself. There are two exceptions.
The only exceptions are if you’re submitting something on behalf of someone else with their consent, or you are porting an old addon and following the guidelines set in Rule 15 (see below).- Example: Repacks of others’ content with nothing new added will not pass.
- No plagiarism!
If you do not have permission to use someone else’s work in your mod, and it was not marked as Open Assets, it will be rejected.
- Credit and Link any Open Assets!
If your mod uses anything marked as Open Assets, you must credit its author and provide a link to it in your mod's description. Even if your own mod is not marked as Open Assets, it's important to support the original work by crediting it as this makes it easier for others to discover the used addons.- If your addon is a direct continuation or edit of another Open Asset addon, it must also be marked as Open Assets. Failure to do so will either result in rejection or have your addon forcefully marked as Open Assets.
- Please keep unorganized Ring Racers and SRB2Kart characters in a single place.
We prefer that each creator keeps only one pack, but if you have enough characters, you may create additional entries for the sake of organization based on theme or mechanics (series, original characters, Lua, collaborative works, etc).- Example: A user creates 5 characters with no common theme, so they submit them as a single pack and update as they add more.
- Example: Another user creates a collection of Pizza Tower characters, several of their original characters, and some characters that utilize Lua to provide interesting new driving mechanics. These could be separated into three different packs, uploaded as separate Addons & More entries.
- When making a Ring Racers or SRB2Kart character with Kartmaker, you should check if there aren't any name templates left behind.
- This applies to anything found in the skin text lump (S_SKIN) that has "EXMP" in it. You can change it to something else that represents anything related or closely resembles your character's name, it's up to your criteria, but it must be four letters total.
- Custom color packs must include at least 3 colors per pack and you cannot post more than two color packs per year.
Player colors are very easy to make, so to avoid addon spam we require all users to abide by this rule specifically for player colors.- A single color would not make a suitable release, but custom characters can have custom colors and/or include these colors as additional downloads. Since the color is supplementing another addon, it isn't a color pack.
- The 2 color packs per year rule is meant to limit the posting of new color addons, please be aware that there is no restrictions on updating your color packs. You can add colors to your existing packs as much as you'd like!
- Your submission must work at a basic level.
Mods that immediately soft-lock or crash will not be accepted.
Also be aware that if your addon is missing basic assets or features (map thumbnail, proper SOC definitions, player starts, anything else needed for the game you made the addon for to function as intended) then it will not work at a basic level.- Example: If your addon generates errors or warnings in the console, that’s fine, but it must still work as intended. We are not your beta testers, so we don’t dig for the little details.
- Please be aware that all custom characters for all addon submissions must be capable of having visible color changing to be approved. Players are less likely to use characters if they can't use their favorite colors in netgames!
- If your addon works but is missing a few basic features required, don't worry! New creators will need time to learn, and judges always want to see cool stuff added! We'll always tell you exactly what you need to add to your addon, and we're happy to help you with questions too! Just send us a message! There's nothing wrong with re-submitting addons after fixing it!
- SRB2Kart and Ring Racer characters have these specific requirements:
- All icons (Mini-map, Rank, Wanted) must feature clearly visible color changing.
- Make sure all sprites are accounted for! Ring Racers in particular has a death sprite that needs to be used!
- Your character does not need full voice lines or SFX, but they must have a gloat sound, which is used for certain power-ups.
- When posting map submissions you must specify the map's gametypes.
If you post a map pack you should mention the gametypes included in it.- If it's a Singleplayer or Race/Circuit map then it should be beatable.
- If it's a Capture the Flag map then it should have flags from both teams included in it.
- If the map supports any Ringslinger-enabled gametype, then there must be a reasonable amount of normal rings available at minimum.
- If your map is designed for a custom gametype, then you must specify the gametype and ensure it follows the requirements outlined by the original gametype addon post.
- When posting 3D Models for characters, you must provide the line of text for the model.dta file.
This will make it easier for all users to quickly apply your models to their personal models configuration, so please be sure to include it!
- Keep personal disputes out of your addons.
- Example: Your addon may not break other addons on purpose or contain rude messages about other community members.
- Posts uploaded with the intent to offend the original author will be immediately rejected.
- If your mod is a custom build exe, has net-game support, and is incompatible in any way with vanilla SRB2 netplay then it must include a custom MODID to avoid conflicting with vanilla SRB2 net-games on the Master Server.
- Do not pack individual PK3s in a .zip file.
PK3s are already compressed, so putting them in .zip archives does not compress them any further.
If you wish to insert multiple files into a zip file for organization purposes, that would be acceptable.- Example1: Inserting a singular .pk3 file into a zip folder would be disallowed.
- Example 2: Inserting multiple .pk3 files into a zip folder would be allowed.
- Example 3: Inserting any number of uncompressed files (like WADs or Lua files) into a zip folder would be acceptable.
- Do not submit recreations of others' unreleased work without permission. This includes recreating sprites, other graphics, maps, scripts, music, sound, etc seen in publicly showcased Gifs, videos, design documents, or other media.
It's fine to make things with similar ideas, but if you only make that thing because you saw someone else making it first, then we can't accept it. Taking inspiration from other sources is fine, but hijacking ideas you know other people are already working hard on is extremely demotivating for people and discourages community members from sharing their WIPs, and we don't want that kind of environment.
- Do not directly upload content that does not belong to you.
Using content from other people in your submissions is fine, as long as that content was previously released as Open Assets or you've got the author's explicit permission, and your submissions contain content you made yourself. Submitting something you do not have permission to or is just a re-upload or compilation of someone else's work will lead to instant rejection.
- You cannot upload music or sound effect packs solely comprised of music or sound effects you did not make, regardless of whether they're Open Assets or not.
Porting or extracting music and sounds from other sources to replace vanilla sounds and music will not be accepted here.
- When posting compiled code such as executable files, you must provide the source code for it.
- This is to ensure that said code is properly in line with the rest of the rules, as the judges will not be able to tell otherwise!
- Lua and SOC files do not fall under this rule, as they are scripts. Scripts are not compiled, so we can simply view it.
- There is only one exception: ACS source code compiled into BEHAVIOR lumps for Ring Racers maps. There's no risk from ACS, so we're comfortable with this exception.
- Any other exceptions will not be made for this rule, regardless of circumstance. If you do not wish to share your source code, you're better off submitting your software elsewhere.
- Your addon's overview page should accurately inform the user of what the addon adds/does to the game using text and/or gifs. There must be no misinformation in your description.
- You may omit features you deem as spoilers.
- A Gif by itself is ok if it's enough to get the point of the addon across to the user.
- If you wish to release a misleading addon as a joke, you should make it clear that the addon is intended to be as such. How clear you need to be is subjective. You're allowed to use sarcasm but remember that it's at the judges' discretion.>
- If your addon could potentially cause seizures or eyestrain to those playing it, you will be required to include an appropriate disclaimer on your addon page.
Dr. Robotnik's Ring Racers - Extra Guidelines specific to these addons
Due to how different Ring Racers is to SRB2 and SRB2Kart, there's a few extra rules you need to keep in mind for addons made for Ring Racers!
Keep in mind all the rules above still apply! These guidelines are only here for the requirements Specific to just Ring Racers!
- Be sure to use the specific Filename Conventions that are designated for Ring Racers!
- When submitting race maps, the following are requirements for your addon to be accepted:
- There must be 16 proper player starts put into your map.
- Bots should be able to beat your map. It's okay for them to make mistakes, but they should at minimum be capable of completing the track.
- The map must include a functioning finish line with a functional position beam. Make sure players can't get around the position beam before the race starts.
- You must provide a Mini-map for the level.
- Make sure you maps have thumbnails for the map selection.
- When submitting Battle maps, the following are requirements for your addon to be accepted:
- The map must work for both Battle and Prison Egg modes.
- It must include 16 match starts, and 4 player starts. (16 for battle, 4 for Prison Egg co-op.)
- Needs an overtime kiosk with minigen points for the overtime barrier.
- Must place at least one UFO or Prison Egg.
- It must be possible to beat the Prison Egg stage in all difficulties.
- You must provide a Mini-map for the level.
- Make sure you maps have thumbnails for the map selection.
- When submitting Special Stages or Boss Battles, the following are requirements for your addon to be accepted:
- There must be 4 player starts put into your map.
- It must be possible to beat the Level.
- You can either provide video proof, or hope the judges are good enough to beat it! :P
- Make sure you maps have thumbnails for the map selection.
- When submitting Tutorial Stages, the following are requirements for your addon to be accepted:
- You need 1 Player start in the map.
- It must be possible to beat the tutorial.
- You can either provide video proof, or hope the judges are good enough to beat it.
- If your addon contains followers, you must ensure the following applies to every follower to have your addon accepted:
- They should have visible color changing just like Characters!
- They must function, meaning the follower is set up correctly to spawn and follow as best it can. (Ground followers struggle a little on FOFs and such, this is a known issue. Don't worry if your ground follower struggles in FOF-heavy maps.)
- All ACS source code publicly exposed to the Internet will be treated as Open Assets.
- Due to ACS needing to be compiled into a BEHAVIOR lump to function, you shouldn't have to worry about anyone stealing your scripts (it won't work). However, we cannot stop users from using or editing your source code if the ACS source itself goes public (Be it from you posting it, or leaving your SCRIPTS lump in). It's impossible for us to check.
Since we cannot verify if compiled BEHAVIOR lumps are original work, all ASC source code posted publicly in any method (including through a SCRIPTS lump) will be considered Open Assets by our judging team, so please keep your source code to yourself if you'd rather keep your code private! - If you want to share your work with everyone and are ok with others using it, feel free to leave the SCRIPTS lump in your addon! It's up to you whether it's included or not.
- Due to ACS needing to be compiled into a BEHAVIOR lump to function, you shouldn't have to worry about anyone stealing your scripts (it won't work). However, we cannot stop users from using or editing your source code if the ACS source itself goes public (Be it from you posting it, or leaving your SCRIPTS lump in). It's impossible for us to check.
- All music that is added to Ring Racers through addons must have definitions made in a MUSICDEF lump that adds information about the music.
- Make sure to include the name of the song, the author of the song, the source of the song (game, TV show, etc.), and if your song happens to be a remix of another song then you must also define the original composers of the song.
- You can also mark songs as unsafe for content ID systems for streaming and content creation. If you believe that your choice of music can put content creators at risk, then please be sure to mark the song as unsafe for Content ID!
- The following features are optional, but highly encouraged!
- Custom Cup detailing.
- Encore Remaps (The 256-pixel flat used to remap palette indexes for Encore mode, similar to SRB2Kart).
- Follower sounds (aka Horns)
Again, Ring Racer addons are subject to all the normal Submission Guidelines! if you wonder why Characters weren't touched on, it's because the above guidelines are already sufficient!
Ring Racers Mapthing documentation (Optional, but Highly Recommended!)
For those of you who make maps, you may be aware of the Map ID and mapthing community spreadsheets run by some of our community members. For Ring Racers you shouldn't need to worry about Map ID conflicts anymore thanks to the longer IDs available, however mapthings can still conflict if multiple objects share the same ID.
@Mr.Logan was nice enough to create a spreadsheet for documenting mapthing IDs, and we are cooperating to ensure all map creators can ensure their maps will be compatible with all addons as early as possible!
When posting addons that introduce custom mapthings, we recommend including a list of all your mapthings along with the ID numbers you've assigned to each one (This can be on the Overview page itself, or placed into a text file). When your addon is approved, a judge will add the information to the spreadsheet!
We also recommend informing someone on the Judge team whenever you update your addon and add new custom mapthings to it so that we can catalogue it.
Please understand that as Ring Racers is updated, new mapthings may be added to the base game. That means mapthings with smaller IDs have a higher risk of conflicting with a future update for RR.
Last we checked the highest mapthing ID in the base game was 5000, and the vanilla mapthing IDs could go up to 10000 or 20000 with the possibility of updates. If you want to ensure your addon's mapthings stay compatible for as long as possible, we recommend startng at the highest possible range of numbers and working your way down. Ring Racers allows for a maximum of 65535 Mapthings, so if you're the first addon creator to make a mapthing object then you should start with ID 65535, then 65534, and so on.
If KK is starting from the lowest numbers and working upwards while and the community is starting from the biggest numbers and working downwards, you can be sure that no conflicts will ever happen!
If you aren't convinced that preventing mapthing conflicts are worth it, I can assure you that addons that don't cause issues with other addons tend to be very popular in netgames and addon packs players make for themselves and friends. Addons that cause issues for the vanilla game or other addons are less likely to be used, so why not take the time to reserve some slots for yourself?
If you'd like to view the spreadsheet, you can find it here:
COMMUNITY MAPTHING DOCUMENT
General Info General Info,Our advice Thanks to the SRB2 MB Judge Staff for allowing me to collaborate with them with this spread sheet. None of this would've been possible with out their help!,Ring Racers will be getting updates, and since KK works with mapthing IDs starting at 1 your mapthings ...
Rules specific to making ports of addons:
When we say "ports", we are referring to any and all addons made to work in another version of the game, fix bugs, or allow them to load alongside other addons that would otherwise not be compatible.
If you are unsure of whether you are following a specific rule, please reach out to a judge! We will help you!
Porting addons or content made for previous versions of SRB2 will be allowed so long as they follow these standards:
- If you decide to port an Open Asset addon, you must still follow all the porting rules listed here.
- If an Open Asset addon from an older version is brought to a newer version but has been drastically changed,it would be considered as its own addon rather than a port.
- Don't use this as an excuse to port Open Asset addons without following these guidelines, if we deem that the addon hasn't changed in function at all then we'll assume it's supposed to be a port and then check if the addon follows these rules.
- To port an Open Asset addon,you essentially have to limit yourself to only maintaining the addon rather than adding onto it. That is what it means to port.
- Both ports and updates made for older Open Asset addons can co-exist on the MB.
- Of course, the port must also maintain the Open Asset prefix. You cannot stop people from editing your port if the original addon was open for everyone to modify!
- If an Open Asset addon from an older version is brought to a newer version but has been drastically changed,it would be considered as its own addon rather than a port.
- The addon must stay faithfully accurate to the original release.
- You cannot add new features or content to the port, such addons are considered "updates" and are not treated as ports.
- Maintain the original textures, level sectors, sprites, functions, etc. Everything should look the same as before.
- If you wish to include ports or recreations of old vanilla objects or mechanics alongside your port, feel free to do so. So long as the purpose of the added content is to recreate how the original addon functioned in the SRB2 version it was intended for, it will be permitted.
- In case there's a need to recreate the original features through any new modifications,you may feel free to do so as long as it doesn't significantly affect the experience of the addon. Like for example re-doing map sectors that don't properly convert, scripting new Lua to re-create removed features, etc.
- You are allowed to optimize any Lua code within your port. Players aren't going to see the lines of code you made, they'll see whatever is happening on the screen. So long as the experience is faithful, the code being different doesn't matter.
- You cannot add new sprites to your ported addon,except when absolutely necessary for it to faithfully function as it were in its original state, or if it's to make it work with basic features not found in old versions of the game (See details below).
- Character skins only require STND (STIN for Ring Racers) sprites in order to function, thus any additions beyond what was found in the original addon will be rejected. This is because the sprite2 system automatically populates placeholders for all other animations.
- We will allow exceptions under these conditions:
- The sprite2 animation being added is intended for an in-level mechanic or object that was either absent from or lacked character-specific sprites in the addon's original SRB2 version. As of 2.2.13, this only qualifies for LIFE, SIGN, GASP, RIDE, and all NiGHTS related sprite2s.
- The sprite2 animation being added is intended for a HUD item that was either absent from or lacked character-specific sprites in the addon's original SRB2 version. As of 2.2.13, this only qualifies for XTRA (big head icon, CSS art, small continue icon, and ending constellation).
- The sprite2 animation being added is required by our rules. Currently, this only qualifies for Ring Racers' DEAD sprite2.
- The sprite2 animation is automatically created through Ring Racer's version of KartMaker when populating the spritesheet with sprites from the original addon. This exception specifically exists to allow ports of Kart characters to receive the Ring Racers' additional vibration effects.
- If you do end up needing to add new sprites to the addon, ensure the new sprites maintain the original art-style and is consistent with what already exists.
- You may trace, copy, or edit pre-existing sprites in order to accomplish this.
- Ensure your addon follows the extra Filename Convention rules specific to addon ports.
- Porting rules are for porting a mod to a different version of the same game. You cannot port an addon to a different game than what the addon was made for.
- SRB2, SRB2Kart, SRB2 Persona, Ring Racers, all count as different games.Ask permission if you want to port something between them!
- You are allowed to port an addon made for SRB2 to the latest version of SRB2!
- You are not allowed to port an addon from SRB2 to SRB2Persona, SRB2Kart, Ring Racers, or any other game other than SRB2 itself.
- If you do wish to do this, the addon will be treated as an "update" and will require the usual permissions to modify the addon.
- SRB2, SRB2Kart, SRB2 Persona, Ring Racers, all count as different games.Ask permission if you want to port something between them!
- You cannot back-port any addons! (Back-porting is to port new things to older versions.)
- The purpose of porting addons is to preserve them for the newest versions of the game the addon was made for,porting addons to previous versions of the game goes against the purpose of porting.
- Acceptable: An addon port from SRB2 2.1 to the latest version of SRB2.
- Unacceptable: An addon port from SRB2 2.2 to SRB2 2.0.
- The purpose of porting addons is to preserve them for the newest versions of the game the addon was made for,porting addons to previous versions of the game goes against the purpose of porting.
- You must include an internal text file inside the addon with credits to all people responsible for creating and porting the addon.
- The names of those who ported the addon must be specifically listed as porters.
- The names of those who originally made the addon must be included and listed as the original developers.
- You must provide a link to where you found the original addon in the text file.
- If the link is dangerous, untrustworthy, or simply dead, you will be required to state where you got the mod from and why you are unable to provide a link.
- If the original addon is found off-site (not on the SRB2 MB) then you will be required to post the original addon file alongside your updated port. You can include it as an attachment to the discussion tab after a submission.
- The porter must include an internal text file into the addon that lists all the changes made to the addon.
- Everything you change must be listed. This includes palette conversions, Lua scripting, texture imports, and literally anything else you did to update the addon.
- Make sure every change is organized into sections related to the edited content.
- All Lua changes should be in its own sections separate from Map or texture changes.
- If it's difficult for the judges to understand the changelog, your addon may be rejected.
- All ports must go in the Ports subsection of Addons & More.
- It doesn't matter what kind of addon it is, if it's a port then it has to be in that specific category.
- Updates to old addons that add features or new content outside of the realm of rule 2 are not considered ports.
- If a port is already available in Addons & More, duplicate ports will be rejected if it is still actively maintained.
- One exception is when the Original Developer makes an official port. If this happens and you previously submitted a port of the same content, then your addon may be de-listed or locked at the discretion of the Judging team.
- Another exception is when a port is no longer being actively maintained.If this happens, you can submit your own updated version of the port. Just make sure to specify which addon thread you intend to succeed so that the Judges know.
- This applies to any addon not being actively maintained, not just addons from previous major versions! If there's an old character who was released for SRB2 2.2.1 that doesn't work, then you may port that character to work with the latest version!
- If you made bugfixes for any particular addon, you are allowed to post it in the addon's discussion threads so that the original developer can potentially add your changes to the addon.
- You can also privately send it to them through conversations (this forum's direct message system).
- Porting MD2 or MD3 models have a few special requirements you need to consider:
- 3D models that have been degraded due to multiple instances of editing will be rejected. MD2s and MD3s are lossy datatypes which degrade each time they're edited directly. Try to keep this in mind and do your best to maintain the original look of the models.
- You are only allowed to add new animations to models if the addon or vanilla content the model is intended for adds new sprites. Said new animations must only be for the respective new sprites (refer to porting rule 2).
- Ports of models must be intended for use with either ports of addons the model was intended for or, in the case of models for old vanilla content, equivalent vanilla content in current SRB2.
- Acceptable: A model of 2.1 Sea Egg intended for a port of 2.1 Sea Egg. A model of 2.1 Sea Egg intended for 2.2 Sea Egg. A model of 2.1 Rosy intended for a port of 2.1 Rosy.
- Unacceptable: A model of 2.1 Rosy intended for an update of 2.1 Rosy. A model of 2.1 Rosy intended for 2.2 Amy. A model of 2.1 Vector intended for Vector as he appears in ChaotixChars.
- You will always be allowed to host your ports via Netgames, the SRB2 Discord, or in regular forum posts so long as they are still faithful.
- You cannot make threads for the sole purpose of distributing unofficial ports, but you may share them in other threads if it's appropriate and relevant to do so.
- If you frequently share your ports in situations when not appropriate or relevant to the discussion, a moderator may take action.
We reserve the right to make exceptions to any of these rules where we find it justified to do so.
When posting your submission, make sure you do the following:
- Upload your mod files using the top Attach Files button.
If your file is too big to fit, use a split .RAR or .7z file. You may have mirrors on other hosts, but the entire submission needs to be uploaded to the message board.
- Upload screenshots to go along with your submission using the bottom Attach Files button.
Nobody's going to be interested in your modification without being able to see it first. Remember that movie mode (F9 to enable/disable) can record animated GIFs of gameplay when your modification can't be shown off by a still screenshot.- If you want to include full-sized images in the body of the post outside of the screenshots section, right click the uploaded picture in the attachment manager to get its URL, and then use that URL in IMG tags as normal.
- Do not use external hosts such as Discord or Imgur for screenshots used in the release post. Using sites like Imgur for minor banner images or promotional images is fine.
- When uploading images for use in-line inside of the post (ex: promotional images or an intro/cover image), keep in mind that if the file-size is too large transparency may break, and that you can avoid the "click to see full size" banner by keeping the width of the image under 640 pixels.
- Please ensure that you use the the bottom Attach Files button to upload screenshots, otherwise they will appear as part of your mod's game files, which can confuse people.
Finally, please be patient. The community judges are people too and it may take over a week for your submission to be looked at. If it has been over a week with no response, please contact us using this sub-forum.[/size]
Last edited by a moderator: