Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ookii-tsuki/SafeValues
A simple Unity library for cheating prevention
https://github.com/ookii-tsuki/SafeValues
anticheat gamedev protection speedhack unity unity3d-plugin
Last synced: 4 months ago
JSON representation
A simple Unity library for cheating prevention
- Host: GitHub
- URL: https://github.com/ookii-tsuki/SafeValues
- Owner: ookii-tsuki
- License: mit
- Created: 2020-12-25T19:30:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-19T16:35:57.000Z (almost 2 years ago)
- Last Synced: 2024-01-14T18:26:45.883Z (5 months ago)
- Topics: anticheat, gamedev, protection, speedhack, unity, unity3d-plugin
- Language: C#
- Homepage:
- Size: 4.11 MB
- Stars: 108
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.TXT
Lists
- awesome-unity3d - SafeValues - A simple Unity library for cheating prevention (Open Source Repositories / Anti-Cheat)
- awesome - ookii-tsuki/SafeValues - A simple Unity library for cheating prevention (C\#)
README
Table of Contents
## About The Project
This is a small project I have been working on for anti cheating in Unity Engine.
It allows you to protect your game from cheating tools but it doesn't protect its files from being ripped off.
###### Key Features
* Hides variables in memory.
* Encrypts and extends PlayerPrefs.
* Detects speedhacks.
## Getting Started
### Installation
* Download the [Latest release](https://github.com/med9999/SafeValues/releases/tag/1.0.1.0) then extract `SfVal.zip` and place the `SfVal.dll` and `SfVal.xml` files in Assets/Plugins of your project.
* It is recommended to build your game with IL2CPP.
## Usage
### Safe Values
**These structs hide values from cheating tools by making an offset to them**
* Example of hiding a float/integer from cheating tools.
```csharp
using Med.SafeValue;
using UnityEngine;
public class Test : MonoBehaviour
{
SafeFloat speed = new SafeFloat(500f);
SafeInt health = new SafeInt(100);
SafeLong plId = new SafeLong(57821103964721L);
public RigidBody rb;
public void DealDamage(int amount)
{
health.Value -= amount;
}
public long GetID()
{
return pl.Value;
}
void Update()
{
rb.velocity = Vector3.forward * speed.Value * Time.deltaTime;
}
}
```
### Player Saves
**This class saves and loads various data types and classes using AES encryption to playerprefs.**
* Example of Encrypting/Decrypting and saving/loading a custom serializable class to/from PlayerPrefs using AES encryption
```csharp
using Med.SafeValue;
using UnityEngine;
public class Test : MonoBehaviour
{
public Card card;
void Awake()
{
//It is recommanded to set an encryption key, otherwise it is going to use a default key
//Warning: always use the same key when encrypting or decrypting
PlayerSaves.Key = "/A?D(G+KbPeShVmYq3t6w9z$C&E)H@Mc";
}
public void SaveCard()
{
//will encrypt and save the class in playerprefs
PlayerSaves.EncryptClass(card, "card1");
}
public Card LoadCard()
{
//will load the class from playerprefs and decrypt it
return PlayerSaves.DecryptClass("card1");
}
[System.Serializable]
class Card
{
public string title;
public int number;
public bool isLegendary;
}
}
```
* Example of Encrypting/Decrypting and saving/loading values to/from PlayerPrefs using AES encryption
```csharp
using Med.SafeValue;
using UnityEngine;
using System;
public class Test : MonoBehaviour
{
SafeFloat speed = new SafeFloat(500f);
SafeInt health = new SafeInt(100);
string title = "Plane 1";
char plClass = 'C';
long id = 15120548466974L;
DateTime lastSaved = DateTime.Now;
bool isActive = true;
void Awake()
{
//It is recommanded to set an encryption key, otherwise it is going to use a default key
//Warning: always use the same key when encrypting or decrypting
PlayerSaves.Key = "/A?D(G+KbPeShVmYq3t6w9z$C&E)H@Mc";
}
public void SaveValues()
{
//will encrypt these values and save them in playerprefs
speed.Value.EncryptFloat("plSpeed");
health.Value.EncryptInt("plHealth");
title.EncryptString("plTitle");
plClass.EncryptChar("plClass");
id.EncryptLong("plId");
lastSaved.EncryptDateTime("plLastSaved");
isActive.EncryptBool("plAct");
}
public void LoadValues()
{
//will load these values from playerprefs and decrypt them
speed.Value = PlayerSaves.DecryptFloat("plSpeed");
health.Value = PlayerSaves.DecryptInt("plHealth");
title = PlayerSaves.DecryptString("plTitle");
plClass = PlayerSaves.DecryptChar("plClass");
id = PlayerSaves.DecryptLong("plId");
lastSaved = PlayerSaves.DecryptDateTime("plLastSaved");
isActive = PlayerSaves.DecryptBool("plAct");
}
}
```
### Anti-Speedhack
**This class detects speed hack attempts**
* Example of setting up an anti speed hack to detect speed hacks
```csharp
using Med.SafeValue;
using UnityEngine;
public class Test : MonoBehaviour
{
void Awake()
{
//starts the anti speed hack detection process and calls CloseGame() when a speed hack is detected
StartCoroutine(AntiSpeedHack.Start(CloseGame, 2f, true));
}
//This will be called if the AntiSpeedHack class detected a speed hack
void CloseGame()
{
Application.Quit();
}
}
```
## Demo
Try a WebGL [Demo](https://ookii-tsuki.github.io/SafeValues/index.html)
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
Med Ben Chrifa - [email protected]
Project Link: [Safe Values](https://github.com/med9999/SafeValues)