https://github.com/eddytheco/nftqmlshimmerpp
https://github.com/eddytheco/nftqmlshimmerpp
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eddytheco/nftqmlshimmerpp
- Owner: EddyTheCo
- License: gpl-3.0
- Created: 2023-10-05T09:54:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-27T06:36:47.000Z (over 1 year ago)
- Last Synced: 2025-02-07T08:34:37.589Z (4 months ago)
- Language: C++
- Homepage: https://eddytheco.github.io/NFTQMLShimmerpp/
- Size: 829 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Extend QML using Shimmer++ libraries
The repo is used for demonstration purposes on how to define QML types using C++ and specifically the [Shimmer++ Libraries](https://eddytheco.github.io/Shimmerpp/about/).
The custom type takes care of monitor the NFT outputs on certain address.
## How to reuse
The CMake project on this repo define a target called `nftMonitor` that defines the `QMLMonitor` and `CPPMonitor` QML elements.
This QML types can be reused in your CMake project by using CMake Packages.
* Using [find_package](https://cmake.org/cmake/help/latest/command/find_package.html) `Config mode` after installing the library on the system.
Like:
```
find_package(nftMonitor REQUIRED CONFIG)
```
* Using [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html)
Like:
```
FetchContent_Declare(
nftMonitor
GIT_REPOSITORY https://github.com/EddyTheCo/NFTQMLShimmerpp.git
GIT_TAG main
)
FetchContent_MakeAvailable(nftMonitor)
```
Then you need to link the backing (and plugin) target to your target like
```
target_link_libraries(yourTarget PRIVATE nftMonitor
$<$,STATIC_LIBRARY>:nftMonitorplugin>
)
```
For the QML engine to find the module one needs to add the path of the module, in this case `/esterVtech.com/imports`.
Like:
```
// Add `/esterVtech.com/imports` to the QML Import Path https://doc.qt.io/qt-6/qtqml-syntax-imports.html
engine.addImportPath("qrc:/esterVtech.com/imports");
```
## Example of using the library
An example on how to use the QML types in an application is present on this repo.
The example use two NFTMonitor element to create a [simple NFT game](https://eddytheco.github.io/NFTQMLShimmerpp/)
The game consists of comparing addresses based on the NFTs they hold.
Each address is assigned an attack coefficient based on one of the NFTs they hold.
You can mint your own NFT and the game will assign an attack coefficient.
Also, the name on the metadata field of the NFT Output will be shown.
So you can brag about the NFTs you have by only sharing your address.
The NFTs issued by estervtech will have the maximum attack coefficient.
This is a very simple game just to show the use of the library.