SC Essentials

The common and essentials scripts used across our projects providing code reusability and fast prototyping. This is also required by other SC modules.

Table of Contents

• Installation
• Configuration
• Usage
• License

Installation

Simply import this package into Unity. You can also set this repository as a submodule and always keep this up to date. Add it in Assets/SweatyChair/Essentials/. Your .gitmodules should have these lines:

[submodule "Assets/SweatyChair/Essentials"]
	path = Assets/SweatyChair/Essentials
	url = https://github.com/sweatyc/Essentials.git

Configuration

All settings are located at menu toolbar > Sweaty Chair > Settings.

Usage

External Plugins

Essentials uses the follow plugins:

• Anti-Cheat Toolkit
• Easy Save 3
• Easy Mobile Pro
• I2 Localization
• LeanTween
• Pool Manager
• Time-cheat prevention
• Unity-UI-Extensions

Modules Details

Analytics

Game analytics and tracking.

Currencies

Virtual currency system, also works with IAP and use anti-cheat.

Databases

Database system that reads CSV and converts to accessible class in-game.

Editor

Editor only tools, such as build tool and reference finder.

Gameplay

Tools and utilites for common gameplay, such as bullet spawning.

GameSave

A system that saves players' progress and sync with Game Center and Play Games.

Helpers

All in-game helpers not categoized elsewhere.

Infos

Player info helpers.

Inputs

Player inputs managers and utilities, such as keyboard and mobild touches.

Items

The common item data classes that can be used in game.

Localize

Translation and localization utility.

Managers

The master managers that not categorized elsewhere.

Server

The utility that posts and retrieves data from the backend server.

Settings

Game settings helpers, such as graphics quality and sound volume.

Shops

Common shop functionalities, for items selling with virual currency or real money.

Singleton

Singleton base classes.

States

Game state functionalities. Set and fire events of current game state.

TweenOnEnable

Tweens objects using LeanTween.

UI

All commonly used UI scripts and prefabs.

• BetterUI

  Replacing some stock Unity's UI.

• Buttons

  Button effects and extended functionalities.

• Effects

  Common UI effets.

• InputFields

  A in-game input field box.

• Loading

  A loading screen between each game loading.

• Messages

  A message box shown in game.

• Panels

  All commonly used panels.

• PasswordField

  An extended InputField for passwords.

• ProgressBars

  A progress bar shows player's progress, HP, etc.

• Tabs

  Sub panel tabs that can switch around in a panel.

• Texts

  In-game texts such as in-game notices and announcements.

• Transition

  Transition between menus, game levels, etc.

• Utilites

  All UI tools that not categorized elsewhere.

Utilities

All tools that not categorized elsewhere.

License

SC Essentials is licensed under a MIT License.