https://github.com/AGulev/ppreader
Defold Native Extension for reading Unity PlayerPrefs
https://github.com/AGulev/ppreader
defold defold-game-engine defold-library playerprefs
Last synced: 4 months ago
JSON representation
Defold Native Extension for reading Unity PlayerPrefs
- Host: GitHub
- URL: https://github.com/AGulev/ppreader
- Owner: AGulev
- Created: 2019-05-22T20:53:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-11-02T15:43:59.000Z (over 2 years ago)
- Last Synced: 2025-02-06T17:57:22.859Z (4 months ago)
- Topics: defold, defold-game-engine, defold-library, playerprefs
- Language: Lua
- Size: 22.5 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-defold - PPReader
README
# PPReader
PPReader [Native Extension](https://www.defold.com/manuals/extensions/) for the [Defold Game Engine](https://www.defold.com)
This library helps to read Unity PlayerPrefs file as a Lua table.
[](https://github.com/AGulev/ppreader/actions)
## Possible use cases:
* If you want to update your Unity game with Defold version of the game and the user's progress is stored in PlayerPrefs.
## Platforms
* **iOS**
* **macOS**
* **Android**
## Setup
You can use the PPReader extension in your own project by adding this project as a [Defold library dependency](https://www.defold.com/manuals/libraries/). Open your game.project file and in the dependencies field under project add:
> https://github.com/AGulev/ppreader/archive/master.zip
Or point to the ZIP file of a [specific release](https://github.com/AGulev/ppreader/releases).
### Android
Your `Package` name must be the same as your package name in Unity version of the game. Game `apk` must be signed with the same `Certificate` and `Private key` as Unity version of the `apk`.
[Forum post](https://forum.defold.com/t/how-to-convert-unity-keystore-to-pk8-format/13235) how to convert your Unity `Certificate` and `Private key` for using with Defold.
### iOS
Your `Bundle Identifier` must be the same as your bundle identifier in Unity version of the game. For the signing process, you must use the same `Code Signing Identity` and `Provisioning profile` as for Unity version of the game.
### macOS
Your `Bundle Identifier` must be the same as your bundle identifier in Unity version of the game. For the signing process, you must use the same `Code Signing Identity` and `Provisioning profile` as for Unity version of the game.
Add next lines to your `game.project` file:
```lua
[ppreader]
company_name = YourCompanyName
product_name = YourProductName
```
Where `YourCompanyName` is the name of the company from your Unity project (`Project Settings`->`Player`->`Company Name`) and `YourProductName` is the name of the product from your Unity project (`Project Settings`->`Player`->`Product Name`).
## API
#### `ppreader.get()`
Returns table with PlayerPrefs values and path to the file:
```lua
local ppreader = require("ppreader.ppreader")
local player_prefs, path_to_the_pp_file = ppreader.get()
pprint(player_prefs) -- Example:
--{
-- UnityGraphicsQuality = 3,
-- field = "string",
-- unity.player_sessionid = "your_session_id",
-- scores = 100,
-- unity.cloud_userid = "your_cloud_user_id",
-- New item = "",
-- some_FloatField = 2.3303999900818,
-- unity.player_session_count = "6",
-- SomeIntField = 100,
-- some_string_field = "some_sctring_for example-just-test@"
--}
print(path_to_the_pp_file) -- Example: /Users/your_user_name/Library/Preferences/unity.TestCompany.TestProduct.plist
```
## Special thanks
PPReader library uses [XML2LUA](https://github.com/manoelcampos/xml2lua).
## Issues and suggestions
If you have any issues, questions or suggestions please [create an issue](https://github.com/AGulev/ppreader/issues) or contact me: [email protected]
Feel free to make a pull request if you know how to improve the code.