Skip to content

Latest commit

 

History

History
116 lines (82 loc) · 4.44 KB

README.md

File metadata and controls

116 lines (82 loc) · 4.44 KB

The Complete Guide to Sprunki Mod

Welcome to the comprehensive guide for Sprunki Mod! This repository aims to provide all the information you need about Sprunki Mod, whether you're a player, developer, or contributor.

Table of Contents

  1. Introduction to Sprunki Mod 1.1 What is Sprunki Mod? 1.2 How to Play Sprunki Mod
  2. Part 1: For Sprunki Mod Game Players 2.1 Web-based Sprunki Mod Games 2.2 App-based Sprunki Mod Games
  3. Part 2: For Sprunki Mod Game Developers
  4. Part 3: How to Contribute to This Repository

Introduction to Sprunki Mod

What is Sprunki Mod?

Sprunki Mod is an innovative extension of the popular music creation game, Incredibox. It allows players to create unique musical compositions through interactive, customized versions of the original game. Each Sprunki Mod offers a distinct experience, often featuring new sounds, visuals, and gameplay mechanics.

How to Play Sprunki Mod

Playing Sprunki Mod is intuitive and fun:

  1. Choose a Sprunki Mod game from the lists below.
  2. Click on different characters or elements to add sounds to your composition.
  3. Experiment with different combinations to create unique beats and melodies.
  4. Some mods may have special features or gameplay elements - explore and enjoy!

Part 1: For Sprunki Mod Game Players

Web-based Sprunki Mod Games

All games listed below can be fully experienced online at sprunki-mod.org.

Game Name URL Description Developer
Classic Sprunki Play The original Sprunki Mod experience Orignal from Scratch
unnamed Play V2, wait players to find suprise! NyankoBfLol on Itch
Incredibox - Sprunkalotl Play Wait players to find suprise! PrimePghLFilms on Itch
sprunki but so good Play Sprunki makes you sprunk everywhere s0larr on Itch

App-based Sprunki Mod Games

Game Name Description
Sprunkis (Available on iOS and Android)
Sprunki Renewal - "Not Funny, Didn't Laugh" Mod from Scratch (Windows only)
Sprunki (android) not official android version (Android only)

Part 2: For Sprunki Mod Game Developers

Creating your own Sprunki Mod is an exciting way to contribute to the community. Here's a brief overview of the process:

  1. Familiarize yourself with the Sprunki Mod framework

    • Study existing mods to understand the structure
    • Review the documentation in the docs folder of this repository

  2. Plan your mod

    • Decide on a theme or concept
    • Sketch out your visual and audio elements

  3. Develop your mod

    • Use the Sprunki Mod development kit (available in the dev-kit folder)
    • Create or source your audio samples
    • Design your visual elements

  4. Test your mod

    • Get feedback from other developers or beta testers

  5. Submit your mod

    • Submit your mod for review

For a detailed guide, please refer to the DEVELOPER_GUIDE.md (still on work) file in this repository.

Part 3: How to Contribute to This Repository

Welcome any contributions to improve and expand this guide! Here's how you can contribute:

  1. Fork the repository

    • Click the 'Fork' button at the top right of this page

  2. Clone your fork

    git clone https://github.com/shanelan/sprunki-mod.git

  3. Create a new branch

    git checkout -b your-feature-branch

  4. Make your changes

    • Update or add content
    • Ensure your changes are clear and well-documented

  5. Commit your changes

    git commit -m "Add a brief description of your changes"

  6. Push to your fork

    git push origin your-feature-branch

  7. Create a Pull Request

    • Go to the Pull Requests page
    • Click 'New Pull Request'
    • Select your fork and branch
    • Add a title and description for your changes
    • Submit the Pull Request

Thank you for helping make this Sprunki Mod guide even better!