Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 5 KB

README.md

File metadata and controls

69 lines (53 loc) · 5 KB
Raw

web3.unreal

web3.unreal is the first plugin to bring true web3 functionality to desktop games built with Unreal Engine. Start making reads and writes to any EVM compatible blockchain in minutes with globally available async blueprint nodes.

This project is free and open source. It will continue to evolve to fit your needs.

Discord Twitter

Documentation

Full documentation of every CPP header file can be found here along with a quickstart guide and common web3 functionality examples: https://web3unreal.readthedocs.io/en/latest/

Installation

Follow these instructions to install the web3.unreal plugin:

  • Close your existing Unreal Engine app.
  • Create a directory in your app root called Plugins.
  • Clone with
git clone https://github.com/G7DAO/web3.unreal.git ./Plugins/web3Unreal

or if your project uses git, add as a submodule with

git submodule add https://github.com/G7DAO/web3.unreal.git ./Plugins/web3Unreal
  • Start your app & it will ask to compile the plugin. Proceed with that.
  • You might need to setup Visual Studio for Unreal Engine.

Common Issues

  • You must "Generate Visual Studio Project Files" and build through your editor
    • We will be distributing precompiled plugin files soon so non C++ UE projects can use web3.unreal

Contributing

Follow these instructions to start contributing to web3.unreal:

  • Clone the fps demo project or follow the "Installation" steps above for you own project
  • Right click FPS_Demo.uproject, click Switch Unreal Engine Version, and select the engine version you would like to develop with
    • We have tested with UE 4.27 - 5.2
  • Right click FPS_Demo.uproject and click Generate Visual Studio Project Files
  • Open FPS_Demo.sln
  • Select Development Editor as the build configuration
  • Right click FPS_Demo in the solution explorer and select Build
  • Launch FPS_Demo.uproject
  • If you get a "Fetch is Incompatible" popup, click yes.
    • We include the Fetch plugin as a separate option to Web3.Unreal for making 3rd party rpc calls, but it has restrictive commercial licensing (Creative Commons Non-Commercial license), error prone syntax, and lots of boilerplate.
  • In Content/FirstPersonBP/Blueprints/FirstPersonCharacter, there are many examples of web3 functionality that can be performed with web3.unreal
    • Check out the Web3UnrealExamplesGraph for a list of examples
  • Get some goerli eth here
  • Play the game. Interacting with the items on the wall will request web3 transactions
    • You will need to have the HyperPlay desktop app running to perform this functionality. Download here. Otherwise you will only be able to use web3.unreal for 3rd party reads

Feel free to submit an issue or PR to web3.unreal if you cannot find the functionality that you need. Join us in the HyperPlay Discord in the web-unreal channel as well!

Writes

Sending transactions is made possible through the HyperPlay desktop app. This removes the complexity of Unreal game devs having to integrate complex UI and wallet integration functionality into their game. Through its integration with web2 game stores, in game overlay, and MetaMask, HyperPlay makes this experience seemless for gamers.

Simply drag one of the async write nodes into a Blueprint graph and fill out the input parameters utilizing Unreal's type system. The output pins for common transactions will be available in Unreal types as well. This call should be made client side.

If you cannot find a wrapper node to suit your specific needs, you can use the rpc node to perform any JSON-RPC call. The sendContract node also allows you to perform any smart contract interaction with a developer friendly syntax.

Reads

Reads can be performed locally through the HyperPlay desktop app but these are subject to man in the middle (MITM) attacks. Reads can be conducted through third party nodes as well.

Client Side Only Games

Reads in these types of games would be similar to how client side only games are easily manipulated today since the entire game is on the user's machine.

Client Server Games

It is recommended for client server model games that critical reads be performed server side. You can use web3.unreal to connect to any third party node provider while still enjoying all the functionality and ease of use the plugin already provides. Third party node providers we recommend are Infura, RPCh, POKT Network, or other RPC services.