P1E World is a comprehensive gaming platform, bringing together various exciting mini-games for a seamless, immersive experience.
License: PiOS
Play now on the testnet!
We welcome and encourage community contributions to P1E World. Before getting started, make sure to read and adhere to the following rules:
- Please ensure that your code adheres to our coding standards and conventions.
- Every contribution must have an associated issue.
- Do not mix multiple concerns/changes in a single contribution. Keep it focused for easy review.
- Always base your changes on the latest version of the main branch.
- Javascript
- React (Vite version)
- @React-Three/Fiber
- Firebase
- Pi SDK
To add a new asset (building or avatar):
- Download your asset as a GLB file
- Fork the repository.
- Add your GLB asset to the public folder
- If your asset is an avatar, go to player.jsx in the game-components folder, and replace the src of
<Gltf src={'/path_to_your_avatar.glb'} scale={1} castShadow />and test the scale to find one that works best. Playing with the scale will yield different physics. - If your asset is a building, create a new building.jsx file in the buildings folder of the world-assets folder in the p1e-world folder. Play with the scale and position props to find your prefered scale and position on the map.
- Test your asset in the marketplace, and find the ideal scale.
- Create a Pull Request with a description and reference to the editions you made. The asset will be created in the database upon approval, and all purchases of the asset will be redirected to the creator of the asset.
To add a new minigame:
- Fork the repository.
- Develop the minigame following our coding standards.
- Test your minigame extensively.
- Create a Pull Request with a description and reference to the related issue.
To fix a bug:
- Fork the repository.
- Create a new branch for the bug fix.
- Fix the bug and test your changes extensively.
- Create a Pull Request with a description of the bug and your solution.
To add a new mechanic:
- Fork the repository.
- Develop the mechanic following our coding standards.
- Test the mechanic extensively.
- Create a Pull Request with a description and reference to the related issue.
P1E World is a community-driven project. We would like to thank all of our contributors and supporters. All of the 3D models and art that are used in this project are open source, and credits are given to the artists in the assets' respective files. Please submit an issue or PR if you are not given credit for your work.