Skip to content

Repository files navigation

Pirate Nation — Unity Game (Open Source)

This is the Unity client for Pirate Nation, a web3 game by Proof of Play. The game is no longer operated as a live service, and we are open-sourcing the client to give it back to the community.

Pirate Nation is a light-hearted game filled with high-seas adventure, treasure, and unique characters. Players collect pirates and send them on adventures to gather crafting materials, treasure, and gold; pirates gain experience and level up along the way.

See ARCHITECTURE.md for a high-level overview of the game systems, currencies, and web3 integration patterns.

⚠️ Important: this is an archival source release

This repository does not build out of the box. To open-source it cleanly and legally we had to remove paid, non-redistributable assets and all secrets. You will need to re-add a few things yourself (details below). There is also no longer a live backend for the game to connect to.

  • Engine: Unity 2022.3.51f1 (LTS)
  • License: MIT (for Proof of Play–authored code; third-party code retains its own license)
  • Security: published with a clean, single-commit history; all secrets removed and rotated. See SECURITY.md.

Bring your own assets

The following commercial Unity Asset Store packages and third-party SDKs were removed because their licenses prohibit redistribution. To restore a buildable project, purchase/obtain them and re-import into the paths shown:

Asset / SDK Original path
Sirenix Odin Inspector & Validator Assets/Plugins/Sirenix/
DOTween Pro (free DOTween is retained) Assets/Plugins/Demigiant/DOTweenPro/
CodeStage Anti-Cheat Toolkit (ACTk) Assets/Plugins/CodeStage/
Better Build Info Assets/Plugins/Editor/BetterBuildInfo/
Privy SDK (auth / embedded wallet) Assets/Plugins/Privy/
Sentry (error reporting) Assets/Plugins/Sentry/
Epic Toon FX Assets/ThirdPartyResources/Epic Toon FX/
ProTips Assets/ThirdPartyResources/ProTips/
Stylized Water 2 Assets/ThirdPartyResources/StylizedWater2/
Voxel Importer Assets/ThirdPartyResources/VoxelImporter/
Highlight Plus Assets/ThirdPartyResources/HighlightPlus/
EnhancedScroller v2 Assets/ThirdPartyResources/EnhancedScroller v2/

Because these are removed, you should expect compilation errors (e.g. Odin attributes, DOTween Pro APIs, CodeStage ObscuredString/ObscuredInt, Sentry, and the Privy auth path) until they are restored or stubbed out.

Bring your own keys

All credentials were removed. To run against your own infrastructure, supply your own values where placeholders ("") now exist, notably:

  • Assets/_PirateNation_/Game/Core/Runtime/Constants.cs — Infura, Alchemy, Etherscan, BlockNative, Sentry DSN, Magic Link publishable key.
  • Assets/_PirateNation_/Game/Backend/Runtime/Core/*_NetworkConfig.asset — backend apiKey and RPC URLs.
  • Assets/_PirateNation_/Game/Backend/Runtime/Forwarder/PopForwarder.cs — HMAC secret.
  • DotNet/PiratePvPShared/Server/API_KEY / GAME_SERVER_API_KEY (read from environment variables).

Never commit real credentials. Local wallet keys belong in a git-ignored PrivateKey.asset (see .gitignore).

Vendored dependencies

Two previously-private Proof of Play packages are now vendored directly into this repository as embedded Unity packages (no external access required):

  • Packages/com.proofofplay.unitycontracts/ — generated Nethereum contract bindings and on-chain addresses.
  • Packages/com.proofofplay.websocketabstaction/ — websocket abstraction layer.

Other dependencies resolve normally via the Unity Package Manager from public registries / git URLs (see Packages/manifest.json).

Getting started

  1. Install Unity 2022.3.51f1.
  2. Restore the commercial assets listed under Bring your own assets.
  3. Open the project in Unity. Resolve any remaining compile errors caused by missing proprietary APIs.
  4. Supply your own keys/endpoints if you intend to connect to a backend.

Running tests

  • Open Window > General > Test Runner.
  • Select the Edit Mode tab and click Run All.
  • Tests live under Assets/_PirateNation_/Tests.

Contributors

Pirate Nation was built by the team at Proof of Play. Huge thanks to everyone who contributed to the game over its lifetime:

@mattvv · @Yorkums · @bcooley-pop · @0xgarnish · @RyszardMinted · @delantai · @MarioVPoP · @str11ng · @andreydobrikov · @ekarnopp · @pop-yev · @lfeldPoP · @breindy · @vqt123 · @0xBEA25 · @grant-ProofOfPlay · @fariz-pop · @stormcakes · @3ldarin · @SamLucyk · @jonathan-pirate · @Craig-at-PoP · @VeePoP · @aaronbmurray · @amitt-pop · @bryan-pop · @drstrangelove111

Contributing

See CONTRIBUTING.md. This is an as-is archival release; forks are welcome.

About

Open-source archival release of the Pirate Nation Unity client (web3 game by Proof of Play).

Resources

Contributing

Security policy

Stars

84 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages