Contributing

Guidelines

Follow these instructions to start contributing to web3.unreal:

  • Clone the fps demo project (https://github.com/G7DAO/unreal-fps-demo) 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

  • 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: https://goerlifaucet.com/

  • Play the game. Interacting with the items on the wall will request web3 transactions from HyperPlay

    • You will need to have the HyperPlay desktop app running to perform this functionality. Download here https://www.hyperplay.xyz/downloads. 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 web3-unreal channel as well!