From d1007a592f9b7a04d87b2d8be7e9faeb472c9516 Mon Sep 17 00:00:00 2001 From: Fabian Berda Date: Wed, 26 Aug 2020 23:49:33 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3de064b..a2287cb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # BOBCheats - Unity plugin ![GeekBox Logo](https://github.com/wanakubwa/GeekBox-Unity-Game.Area51/blob/master/Game_Images/48x48_Logo.png) + +

+ ### BOB is a smart cheats system for unity games. The idea to create this plugin was one thing, to create a system that would make creating cheats for your game a pleasure. You can create cheats and use it in game by writing just one single method. #### If you like this plugin, you can pin a star :star: on it, and like our [**facebook fanpage**](https://www.facebook.com/GeekBox-109186153819085) :thumbsup: (and left a comment with your opinion) so that you don't miss any more plugins. @@ -97,6 +100,11 @@ Example of using `[Cheat]` attribute with and without parameters. [MIT][mit] © [wanakubwa][author] +

Buy Me A Coffee +
+ You can also support me by buying a coffe! :coffee: +

+ [mit]: http://opensource.org/licenses/MIT [author]: http://github.com/wanakubwa [issue-link]: https://github.com/wanakubwa/BOBCheats/issues From b400d73d136080c3940e927daac1cc009b299531 Mon Sep 17 00:00:00 2001 From: Fabian Berda Date: Wed, 26 Aug 2020 23:51:01 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a2287cb..d19d5bb 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ public class GameCheats : CheatBase ```csharp using BOBCheats; -// Example of class to store cheats with one simple cheat method. +// Example of class to store cheats with simple cheat methods. public class GameCheats : CheatBase { [Cheat] From 4885ee7195165481eddd1b0130903c59bab08e5f Mon Sep 17 00:00:00 2001 From: Fabian Berda Date: Thu, 27 Aug 2020 19:47:02 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index d19d5bb..4c9d136 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,26 @@

-### BOB is a smart cheats system for unity games. The idea to create this plugin was one thing, to create a system that would make creating cheats for your game a pleasure. You can create cheats and use it in game by writing just one single method. +### BOB is a smart cheats system for unity games. The idea to create this plugin was to create a system that would make creating cheats for your game a pleasure. You can create cheats and use it in a game by writing just one single method. -#### If you like this plugin, you can pin a star :star: on it, and like our [**facebook fanpage**](https://www.facebook.com/GeekBox-109186153819085) :thumbsup: (and left a comment with your opinion) so that you don't miss any more plugins. +#### If you like this plugin, you can pin a star :star: on it, and like our [**facebook fanpage**](https://www.facebook.com/GeekBox-109186153819085) :thumbsup: (and left a comment with your opinion) so that you won't miss any more plugins.

Buy Me A Coffee
- You can also support me by buying a coffe! :coffee: + You can also support me by buying a coffee! :coffee:

## :floppy_disk: How do I cheat? (Installation) To start working with BOB, just follow a few simple steps. 1. Download and unpack latest release version of plugin (.unitypackage) from [**Here!**](https://github.com/wanakubwa/BOBCheats/releases) -2. Open BOBCheats settings from *Window/BOBCheats* and click **Create BOBManager**. Then it should spawn a GameObject in Your scene. +2. Open BOBCheats settings from *Window/BOBCheats* and click **Create BOBManager**. Then it should spawn a GameObject in your scene.


BOBCheats settings editor window preview.

-3. Now create a folder i.e. *Cheats* in your project (We will use it for storing game cheats). +3. Now create a folder i.e. *Cheats* in your project (we will use it for storing game cheats). 4. Create a cheats container class inside folder from step **3**. Cheats container must be a class **inherited** from class `CheatBase`. ```csharp using BOBCheats; @@ -33,7 +33,7 @@ public class GameCheats : CheatBase } ``` 5. Inside class defined in previous step write cheats methods, each cheat must be an `public static void` method with `[Cheat]` attribute. -6. Now You can show cheats menu in game by presing **f12 button** in keyboard or **double tap** on screen (mobile device). +6. Now you can show cheats menu in game by pressing **f12 button** on a keyboard or **double tap** on a screen (mobile device). #### Example of a correctly created class with cheats methods. ```csharp @@ -64,13 +64,13 @@ Settings window can be open from *Window/BOBCheats*.

- **Activate key short** - Set key to show BOB menu in game (default f12). -- **Reload cheats collection** - Manual download of all created cheats. +- **Reload cheats collection** - Manual refresh collection of all created cheats. - **Create BOBManager** - Spawn BOBManager in scene hierarchy, can be saved as .prefab. ## Attributes ### [Cheat] Attribute -Each cheat method must have the `[Cheat]` attribute. Using an attribute without parameters will display the cheat name in the menu as a function name with spaces between lower case and upper case letters. The attribute can be defined using a `string` type parameter that defines the name to be displayed in the menu. +Each cheat method must have the `[Cheat]` attribute. Using an attribute without parameters will display the cheat name in the menu as a function name with spaces between lower case and upper case letters. The attribute can be defined using a `string` type parameter that defines the name to be displayed in the GUI menu. Example of using `[Cheat]` attribute with and without parameters. ```csharp @@ -90,10 +90,10 @@ Example of using `[Cheat]` attribute with and without parameters. ## :exclamation: Limitations -- Only prymitive types can be used as an cheat parameters (string, int, float). +- Only prymitive types can be used as cheat parameters (string, int, float).

-

If you found a bug in the plugin or have an idea for additional functionality, open Issue and post your opinion in it. +

If you found a bug in the plugin or have an idea for additional functionality, open Issue and write your opinion in it.

## License @@ -102,7 +102,7 @@ Example of using `[Cheat]` attribute with and without parameters.

Buy Me A Coffee
- You can also support me by buying a coffe! :coffee: + You can also support me by buying a coffee! :coffee:

[mit]: http://opensource.org/licenses/MIT