Getting started

You are interested in the development of Scribble.rs Pad and want to participate?

First you need to install Unity Editor 2020.2.6f1 or newer, which may require a valid Unity ID. You can create one for free at https://id.unity.com and press on create one.

It is recommended to install the Unity Hub, which manages your Unity installations and Unity projects.

Next you need to make sure that you have Git installed. Git is a version control system used for this project. You can get Git for your device at http://www.git-scm.com/downloads.

Open a terminal and go to the root of your Unity projects. Create a new directory for Unity game development if there is none. Clone https://github.com/scribble-rs/ScribblersPad.git or [email protected]:scribble-rs/ScribblersPad.git with the command

git clone https://github.com/scribble-rs/ScribblersPad.git

or

git clone [email protected]:scribble-rs/ScribblersPad.git

, then a new directory called ScribblersPad will be created.

Launch Unity Editor with the project directory selected and give it a go. It is recommended to read about the project layout and naming conventions first to get started.

You just want to translate the game to a different language or want to improve translations?

String translations are located at ./Assets/ScribblersPad/StringTranslations/. Select a string translation asset and add or edit the language of your choice in the Unity Inspector window.

If you need to translate sprites SpriteTranslations or audio files AudioTranslations, then you can create the appropriate directories for them and add your translation assets there.

You are a 2D artist, UI designer or graphics programmer and want to contribute?

Digital images

Make sure your digital arts tool of your choice is installed on your machine. Create your assets and don't forget to save them using the naming conventions for this project. Read the project layout page before contributing. We recommend to export images to PNG (Portable Network Graphics) files.

2D Animations

Animations can be performed inside the Unity Editor through the Animation and Animator windows. If you are working with external animation software, make sure you are able to export your animations to *.anim (animation) or *.controller (animator controller) files.

UI design

Same procedures as digital images or 2D animations, but if you need to alter UI logic, you should get an IDE of your choice to create or edit source code. Preferred IDEs are Rider, Visual Studio or Visual Studio Code. Most if not all UI related events should be exposed in the Unity Inspector window. We use C♯ for our game logic.

Shader programming

This project provides the Unity Shader Graph package, which allows you to create and edit shaders using graphs. If you are into writing shader code, you should get an IDE of your choice. Make sure that your shaders can be compiled into GLSL and HLSL, and make sure that your shaders support those languages.

You are a sound effects designer, music composer or audio programmer and want to contribute?

Make sure your audio tool of your choice is installed on your machine. Create your assets and don't forget to save them using the naming conventions for this project. Read the project layout page before contributing. We recommend to export audio files to FLAC (Free Lossless Audio Codec, lossless compressed), WAV or WAVE (Waveform Audio File, uncompressed) or Ogg ("ogging", lossy compressed).

Music

For music you can also export your music to tracker modules such as IT (Impulse Tracker), S3M (ScreamTracker 3 Module), XM (EXtended Module File Format) or MOD (MODule File Format).

To add your music to the music playlist, you need to create a new music title asset in ./Assets/ScribblersPad/Resources/MusicTitles/ and reference your music there.

Audio programming

If you need to extend audio logic in this game, then you need to edit the source code of this game. Get an IDE of your choice, preferred are Rider, Visual Studio or Visual Studio Code. However most if not all events are available through the Unity Inspector window. We use C♯ for our game logic. Make sure to follow the naming conventions and project layout if you are creating or editing source code.

You are a game programmer and want to contribute?

Get an IDE of your choice, preferred are Rider, Visual Studio or Visual Studio Code.

Modules are split into directories in ./Assets. We use C♯ for our game logic. Make sure to follow the naming conventions and project layout if you are creating or editing source code.

If you want to make changes to Scribble.rs ♯ in ./Assets/ScribblersSharp, please visit https://github.com/scribble-rs/ScribblersSharp instead. Scribble.rs Pad hosts a copy of the source files of Scribble.rs ♯.