# 👾NICE1
## About the NICE1 mentality
We develop services and applications based on Blockchain technology for video games, aimed at democratizing the video game industry by giving developers the necessary tools to implement all its advantages in licenses, assets or skins.
## 🧙♂️4 Gamedevs
{% hint style="info" %}
**NICE1 PLUGIN**
* [Introduction](/nice1-plugin/introduction)
* [Unity version](/nice1-plugin/unity) \[1.0.0] \[OpenSource] ***\[WIP]***
* [Unreal version](/nice1-plugin/unreal-plugin) \[1.0.0] \[OpenSource] ***\[WIP]***
{% endhint %}
## 🌍4 All
{% hint style="info" %}
**JUNGLE4 (EOS TESTNET)**
* [Create EOS Jungle4 Account](/testnet-jungle4/create-testnet-eos-account)
* [Create NFT with SimpleAssets on Jungle4](/testnet-jungle4/create_nft_contract)
{% endhint %}
## 🎮4 Gamers
{% hint style="info" %}
**NICE1 LINK**
* [Introduction](/nice1-link/introduction)
* *`Nice1.link`* 0.5.0 ***\[WIP]***
{% endhint %}
# Introduction
We work on tools for developers through plugins for the main IDEs in the market ([UNITY](/nice1-plugin/unity) & [UNREAL](/nice1-plugin/unreal-plugin)). These tools provide developers with the possibility to implement NFT with free terms of use, simple integration and no fee transactions between players and creators.
The goal is to have a common source code written in C++ that can be compiled for the different IDEs. For each of them, it will be necessary to make the necessary adaptations according to their requirements.
* [**Unity Plugin**](/nice1-plugin/unity)
# ChangeLogs
Last version (Stable):
{% hint style="success" %}
#### NICE1 PLUGIN SUIT | Version 0.X.0
{% endhint %}
* Version 0.5.0 (Initial version)
# Unity Plugin
In this Nice1 guide, you will learn how to import and set up Nice1 plugin for Unity (Windows and Mac).
{% hint style="info" %}
The functionality of this plugin is currently in beta. Its use is supported on the EOS tesnet network (jungle3).
{% endhint %}
### Getting Started
[Download](https://github.com/nice1-blockchain/nice1-plugin/releases/tag/0.0.2b) or [clone](https://github.com/nice1-blockchain/nice1-plugin/tree/develop) our latest version of the Nice1 Unity package.
Next, open up the Unity project you want to use or a blank project. When your Unity project is open, you can import the package from the top Unity Editor toolbar via Assets -> Import Package -> Custom Package
Then from the file explorer select the Nice1 Unity package and import. A window will pop up, hit "OK" to start importing the package into the project.
You can also import the Unity package by dragging and dropping it into the Project tab in the Unity window.
### Any questions?
For those users who have questions, we are working on the [FAQs](/nice1-plugin/frequently-asked-questions) section. Feel free to contact us on our [Discord](https://discord.gg/TeybrwHuna) server too.
{% hint style="warning" %}
**⏳ Documentation under revision, to be published soon.**\
**🙏Thank you for your patience.**
{% endhint %}
# How to use
The Unity package contains the following elements:
## Nice1 folder
Contains the Demos, Plugins, Prefabs, Scripts and UI folders.
* Demos: contains three samples:
* A sample main scene called *CanvasAnchorExampleScene 1* (inherits from project ) It has all you need to create a Login functionality using EOSIO Blockchain Network.
* A sample scene called *Nice1sample* with a configuration of panels, buttons and the prefabs needed to use the login part of the plugin.
* A sample scene called *Nice1CharacterSelectorSample* with a configuration of a set of elements (panels, buttons, prefabs, etc.) required to use the character selector part of the plugin.
* Plugin: contains the plugin, Mac, iOS, Android, WebGL and Windows libraries.
* Prefabs: contains various prefabs:
* LoginPanelAnchor: the login panel to launch Anchor Wallet.
* UserPanel: a panel to display the name of the logged in user.
* WalletManager: contains the scripts for authentication management, license parameters configuration and UI management.
* Character: a button used in the character selection part of the plugin.
* CharacterSelectionScreen: a panel used in the character selection part of the plugin.
* CharacterSelector: a GameObject that contains the necessary elements to configure the componentes of the character selector.
* Scripts: where the different scripts used in the prefabs are stored. It also contains a ScriptableObject with the stored data for the character selector configurator.
* UI: sprites for the login panel.
{% hint style="warning" %}
**⏳ Documentation under revision, to be published soon.**\
**🙏Thank you for your patience.**
{% endhint %}
## Nice1 Login Demo Scene
This demo scene contains the necessary configuration to see how the login part of the plugin works. Due to current restrictions, its operation depends on the incorporation of third-party plugins. The following section explains how to perform the configuration.
## Nice1 Character Selector Demo Scene:
This demo scene contains the necessary configuration to see how the character selector part of the plugin works.
# Play Login!!!!
Open the *CanvasAnchorExampleScene 1* scene and click on Play to see the demo running.
We have a simple button that when clicked will open your wallet. This web view connects with the Anchor Wallet API and will let us log in and check our NFTs.
We can launch the Anchor Wallet program if it's installed or scan the QR code with the mobile app.
I
# How Login works
For Windows, Mac and Linux, use *UnityCanvasTransport* from *AnchorLinkTransportSharp* described in
For WebGL, Android and iOS use WebVIew option.
# Play CharacterSelector!!!!
Once the dependencies are configured, open the scene and run it to see the demo in action.
As you can see, initially, it is the same as the Login scene.
The same web view is opened after clicking the Login button.
If the query didn't find the specified license, we'll get a "No License" text.
Otherwise, a character selection panel will appear for us.
The character licenses are configured from the CharacterSelector in the scene.
Its default data is as follows.
If we click on the green button on the panel in the scene, the licenses will be reloaded. So, for example, if we change the last license to free and update.
Now, we will be able to click the "Capsule" character.
If we click on a button,for example, *Circle*, a message will appear in the console:
Note: To configure the behaviour of each button after clicking on one of them, while the scene is not running from the inspector, you should click on it an add a function in the *OnClick()* method.
# How CharacterSelector works
The demo scene is similar to the login one, but with some additions.
In the scene, we have replaced the WalletManager GameObject with the CharacterSelector, which holds the WalletManager as a child.
It contains the ElementsConfigurator script.
Inside the canvas panel, it also contains the CharacterSelectionScreen GameObject.
Which contains the UISelectorPanel script.
Let's explain each script.
### ElementsConfigurator
It has the information of the components which will appear on the panel. Its sections are as follows:
* Data & elements: It contains information regarding the data to be displayed on the screen, as well as a reference to a ScriptableObject from which to load or to which to save the defined data, and the necessary WalletManager to establish a connection with the server.
* Settings: Within it, the display mode is defined, an owner is set for testing from the inspector without the need to run the scene or perform a login; the UI element where the buttons will be created is specified, along with the prefab of the button to be created for each data (the Character prefab is used).
* Some buttons:
* Load data from scriptable data list: Load the data from the ScriptableDataList into the list of elements that we need to define.
* Save data into scriptable data list: Save the defined data in the list of elements within the ScriptableDataList.
* Create elements in the UI: Remove the elements within the Target component to create a set of prefabs in it using the data entered in the list of elements.\
Note: Once created, these elements should be arranged in the panel.
* Refresh licenses: Verify the licenses to check them and show or hide each button based on whether their corresponding license is owned or not.
### UISelectorPanel
It contains the following references:
* Configurator: The ElementsConfigurator script of the scene.
* User Panel: The panel which will be displayed in case a license is not available.
* Text User Account: Text with the username if the license is available or with the text "No license" if the license is not available.
# Troubleshooting
Troubleshooting common problems with the Nice1 Plugin Unity and known issues/limitations.
{% hint style="warning" %}
**⏳ Documentation under revision, to be published soon.**\
**🙏Thank you for your patience.**
{% endhint %}
# Unreal Plugin
In this Nice1 guide, you will learn how to import and set up Nice1 plugin for your Unreal project.
### Getting Started
To add the Nice1 Plugin into your Unreal project you just need to download or clone our latest version of the Nice1 Unreal plugin and put its content into the `Plugins` folder in your project's root diretory (were your .uproject file is located). You can manually create a `Plugins` folder if it does not exists already.
### Setup
To ensure the Nice1 plugin functions correctly, you need to provide the necessary license and blockchain network information.
1. Launch Unreal Editor: Open your project in Unreal Engine.
2. Navigate to Settings: Go to Edit -> Project Settings -> Nice1 Settings.
3. Enter Required Information: Fill out all the fields with
### Blueprint example
{% hint style="warning" %}
**⏳ Documentation under revision.**
{% endhint %}
# Frequently Asked Questions
**We will answer all your questions at:**
# Compile the plugin for iOS
1. Plugin XCode Project File Lists
2. Everything except the Curl framework can be found in the plugin repository. To install it, download the latest release (zip file) from or
\
3\. Unzip:
Release file content
4. Incorporate Curl into the project as a framework (follow instructions from the source repository). The XCode project configuration should look like this:
5. Add, for both Project and Target, in the “Header Search Paths” property the path where the downloaded curl files are located, checking the recursion option. For example: User/user/curl.framework/\*\*
# Add the plugin to the Unity XCode project.
1. In the Unity project, copy the files resulting from the compilation of the iOS plugin. The output files are:
\
\
2\. Copy them to the Assets/Plugin/iOS path
3. Once the build is done, open the resulting XCode project. Curl must be in the frameworks section and in the Target Membership only UnityFramework appears.
\
\
4\. For both Target Unity-iPhone and UnityFramework, the Search Path properties must include the directory where the Curl library is located recursively. The library will be found in the relative directory Frameworks/Plugins/iOS/curl.framework
\
5. For UnityFramework, in the “Other Linker Flags” property, add -lz
\
6. Configuring Build Phases for Unity-iPhone
\
\
7. Configuring Build Phases for UnityFramework. Check that the libraries are found: libz.tbd, curl.framework and libiosBasicPlugin.a
# Introduction
Soon!
# nice1swapper
Introduction: **An easy way to offer swap between tokens**, valid for EOSio (antelope) blockchains.
With support of PomeloGrants
Github repo:
## Use cases
This contract offers the possibility of exchanging fungible items in video games (backed by tokens), this can be represented with several examples such as the exchange of "10 Apples for 1 apple juice" and vice versa this exchange can be executed in the game processed on the network itself.
It also offers the possibility to acquire special tokens like "fornitebuks" in web3 games in exchange for any token that is required.
As another example of use not focused on web3 gaming, it also allows the exchange of tokens for projects that wish to offer their tokens to users in exchange for other tokens on the chain.
### How it works
As a contract administrator you will be able to run an action that will allow you to configure a swap option with a unique identifier.
In this action you will be able to configure fields such as, the token contract you want to offer and the amount of tokens on one side and on the other side how many tokens you expect to receive for the amount of tokens and from which contract.
You can make different configurations with different ratios according to your needs.
> Example 1: 1EOS = 10Gold , 5EOS = 50 Gold , 10 EOS = 100 Gold\
> Example > 2: 1EOS = 10Gold , 5EOS = 60 Gold , 10 EOS = 150 Gold
Users will only need to make a standard transfer to the contract and will instantly receive the counterpart.
# nice1staking
Introduction: **Offer Rewards to your users for staking!** (Tokens and NFT's)
Github repo:
## Use cases
You have a collection of NFT's and you are thinking of launching a token? reward the holders of your NFT, offering an equal distribution to all of them in exchange for blocking their NFT for X amount of time.
Or you have your own token and you want to launch a new collection of NFT's for your community members.
The limit is set by you.
### How it works
With these 2 contracts you will be able to offer staking campaigns to your users and offer both NFT's and tokens as rewards.
*The 2 versions work independently:*
**n1nfttotoken:** In this version users will be able to lock a specific NFT in the contract for the time needed to receive the reward, once that time is up, the user will be able to claim his NFT and also the tokens offered as a reward for staking. If the user wishes to withdraw from the campaign before the time for the reward is up, his NFT will be returned.
> As an administrator, you can create a campaign in which you can set the start date, the end date, the time required to block the NFT, which NFT you accept for this campaign, maximum number of participants and how many tokens the user will receive for participating.
***
**n1tokentonft:** In this version users will be able to block tokens of any type in the contract for the time necessary to receive the reward, once this time is over, the user will be able to claim his tokens and will receive the NFT offered as a staking reward. If the user wishes to withdraw from the campaign before the time for the reward is up, his tokens will be returned.
> As an administrator, you can create a campaign in which you can set the start date, end date, time required for blocking tokens, which tokens you accept for this campaign, maximum number of participants, whether you want to return the tokens to the participant or take them as payment and what NFT the user will receive for participating.
# n1licensepos
Introduction: **Sell your licenses and assets quickly and independently.** Powered by Nice1
Github repo:
## Use cases
Are you using Nice1 plugins to add the NFT license verification system to the games you have created (BTL-BlochainTrustedLicense)?
With this contract you can easily create your PointOfSale and sell your licenses and assets by accepting as payment any kind of token from the network. You choose!
### How it works
Very similar to a store!
First you will have to register your product, specifying what it is, the price it will have and its internal and external reference if you need it.
Once you have your product registered, you only have to replenish the stock, this is as easy as sending the licenses to the contract and it will automatically manage the remaining units as well as a detailed report of the units sold.
For your users buying your licenses has never been so easy! They only have to send the required amount of tokens to the contract attaching in the memo the reference of the product they want to purchase and in the same transfer in which the payment arrives the license will be sent to your account.
# Create EOS Account (Testnet)
## 📋 Here is step by step how to create an "EOS Account" on the Jungle4 Testnet and thus be able to test on the EOSio network without consuming resources on the mainnet.
In this document we will go through all the steps from
## 1️⃣ Create public and private key.
**Click on "Create Key" and it will generate a public and private key:**
{% hint style="warning" %}
We will save both keys and we can close the pop-up.
{% endhint %}
## 2️⃣ Create account.
**Click on "Create Account" and a pop-up will open where we will be asked for a user name for our account (It must have 12 characters) and 2 fields where we will have to paste our public key.**
{% hint style="success" %}
Once filled in with the account name and the public key in both fields, we complete the captcha and click on create. This will automatically create the account with the name "demosniceone" as shown in the example.
If everything has worked correctly we will receive the following message:
{% endhint %}
***-*****To confirm that the account has already been created, you can click on the "Account Info" link.**
*We must enter the name of the account that we have created and it will return a log with detailed information about it.*
## 3️⃣ Add resources: EOS, RAM, CPU, NET.
**In order to be able to execute contract transactions and other functionalities, we will need to have EOS (Testnet) balance in our account as well as available CPU, NET and RAM resources.**
For them we will use the following functions **"Faucet & PowerUp"**
**-In the "Faucet" section we will simply put the name of the account in which we want to receive the EOS and then EOS will be sent to that account.**
**-We will do the same process in the "PowerUp" section and this will assign a quota of CPU, NET and RAM to our account.**
{% hint style="info" %}
Resources can be claimed as many times as necessary.
{% endhint %}
## ✅Your Jungle4 Testnet account will be ready with the necessary resources to start using it.
If you visit [Jungle4 Explorer](https://local.bloks.io/?nodeUrl=http%3A%2F%2Fjungle4.greymass.com\&systemDomain=eosio) and enter your account name, you will be able to see graphically the current resources available.
# Create NFT (contract)
## CONTRACT
**To start we will access the** [**SimpleAssets (Jungle4)**](https://local.bloks.io/account/simpleassets?nodeUrl=http%3A%2F%2Fjungle4.greymass.com\&systemDomain=eosio\&tab=Actions\&action=create)
Below we will see all the actions allowed by the contract.
{% hint style="info" %}
To create the NFT we will use the "Create" action which will display the following form at the bottom of the page**.**
{% endhint %}
## FIELDS & VALUES
These fields are in charge of filling in the information needed to compose the NFT and display it properly in its sections as shown in the example of the finished NFT.
**-Author Field:** Here we will put the name of the creator's account, we will use the same one from which we coined the NFT, in this case "niceonedemos". (This will apply the Author information from section 2).
**-Category:** We must assign a category in which our NFT will be classified together with others that we create in the future and we want them to be under a specific category. In this case we have used "niconetest" because we want that all the NFT of test, are grouped in the same category. (This hata that in the section 2 the field "Category" is assigned and it is possible to access to all the NFT that contains this category).\
\
**-Owner:** Here we will put the account name that must be the actual owner of the NFT, not to be confused with the creator. In this case we have put our own account "niceonedemos" because we want to receive the NFT once it is minted. (This field will define in section 2 the NFT owner).\
\
**-iData:** Here we can add as much immutable information as we wish. This means that once the NFT is created this information cannot be modified again, not even by the creator of the NFT itself. (We will use this field to assign the name of the NFT in section 3, which will serve to assign a name to the NFT itself).
```
To assign a Name field and its corresponding value, we will use:
{"name":"Test NFT"}
```
**-mData:** Here we will have fields and values that can be modified and updated by the NFT creator at any time. (This will specify the fields and values of the section 4, )
```
Example of data structure to create fields and values used in the example.
{"img":"QmQBJXYeDmyR1QMcPrgtV54mrTeLL4kDyT58mhxBe2i5Zt","Data1":"1","Data2":"2"}
```
Field "img" we can assign an image from IPFS which will be the one shown in section 1, as the representative image of the NFT. (In this case we add the "img" as mdata, in case it is necessary to update it in the future).
{% hint style="warning" %}
In both the iData and mData sections you can add as many fields and values as necessary following the structure shown, fields such as "name" and "img" are required for the NFT to have all the necessary information.
The value of section 2 "Product ID" is generated automatically and is a unique identifier of the NFT in question. (There are no 2 NFTs with the same "Product ID" even if they have the same fields and values.
{% endhint %}
**-Requireclaim:** If this option is checked, the specified owner must claim the NFT to have it in his account, otherwise he will receive the NFT in his account once it is minted.
{% hint style="success" %}
In this way we will have generated an NFT with all the basic information and belonging to a collection of 1/1 , since only 1 NFT has been created as this one.
{% endhint %}
