cygnusfear / laputa

☁️🏯 a world of floating cities 🏰☁️ - EthGlobal 2023

LAPUTA

☁️🏯 a world of floating cities 🏰☁️ - EthGlobal 2023

Sign up for the waitlist

Development

Install dependencies:

mud

mud quick start

Prerequisites

• Foundry

curl -L https://foundry.paradigm.xyz | bash

• Node.js
• pnpm

# after installing node
npm install --global pnpm

Available Scripts

In the project directory, you can run:

pnpm run <script>

Script	Description
build	Builds the app using pnpm.
dev	Runs both contracts and client in development mode concurrently.
dev:client	Runs the client development script.
dev:contracts	Runs the contracts development script.
foundry:up	Downloads and runs foundry, bash, and foundryup.
mud:up	Sets the mud version to main and installs dependencies.
prepare	Installs husky and optionally runs foundryup.
test	Runs tests recursively on all packages.
preview	Compiles TypeScript, builds, and previews the app with Vite.
lint	Runs linting recursively on all packages.
type-check	Runs type-checking recursively on all packages.

References / useful

• 🔥🚒 React-Three-Fiber Performance Pitfalls - Must read on R3F + Three.js
• 🧸📖 Zustand intro - How to use Zustand

laputa's Issues

figure out if we actually want this to be async or if we should render something else in the meantime

laputa/packages/client/src/index.tsx

Lines 15 to 20 in 4a0833a

	// TODO: figure out if we actually want this to be async or if we should render something else in the meantime
	setup().then(async (result) => {
	root.render(
	<React.StrictMode>
	<MUDProvider value={result}>
	<App />

---

This issue was generated by todo-issue based on a TODO comment in 4a0833a. It's been assigned to @Cygnusfear because they committed the code.

Feature shortlist

Resources

• put player resource data in Zustand
• create UI for player resource data
• cursor show can't build

Implementing Player

• read player resource data from wallet
• building ownership is added to player

Resource generation

• player can build a mine facility next to a resource (-1 tile)
• player receives resource upon building
• player can build scaffolding (cheap)

Want to have

• players can choose building color
• players can rotate building (using R)
• players can pick a different variation (using Spacebar)
• facility is previewed in mouse cursor

require player to have enough resources to build this facility

laputa/packages/contracts/src/systems/FacilitySystem.sol

Lines 25 to 30 in 586efcb

	//TODO: require _msgSender() to have enough resources to build this facility
	//require the target position to be empty
	bytes memory _staticData;
	PackedCounter _encodedLengths;
	bytes memory _dynamicData;

---

This issue was generated by todo-issue based on a TODO comment in 586efcb. It's been assigned to @singyiu because they committed the code.

Remove hack to only show gravityhill at startup

laputa/packages/client/src/components/ui/inventory.tsx

Lines 38 to 43 in 4b77c21

	// TODO: Remove hack to only show gravityhill at startup
	if (
	entities.find(
	(entity) =>
	entity.entityType === "facility" &&
	(entity as IFacility).type.name === "Gravity Hill"

---

This issue was generated by todo-issue based on a TODO comment in 4b77c21. It's been assigned to @Cygnusfear because they committed the code.

webhook test 2

could use THREE.InstancedMesh if we're going nuts

laputa/packages/client/src/game/entities/vegetation.tsx

Lines 37 to 42 in fd500de

	// TODO: could use THREE.InstancedMesh if we're going nuts [enhancement]
	return (
	<>
	<Instances limit={limit} geometry={mesh} material={mat}>
	{plantFacilities.map((facility, idx) => {
	return (

---

This issue was generated by todo-issue based on a TODO comment in fd500de. It's been assigned to @Cygnusfear because they committed the code.

Design a quick mousemap tutorial for camera movement (XBOX style what cursor is what)

how this could work:

• first left click shows the overlay for a while, with the clicked button
• this tells the player they can press buttons and get explanation
• we can popup the same overlay for different buttons
• might want to save in localstorage that tutorial is finished

implement a better solution than looping through all players

laputa/packages/contracts/src/systems/DefiSystem.sol

Lines 66 to 71 in 31fb99f

	//TODO: implement a better solution than looping through all players
	function defiDistributeRewardsToPlayers() public returns (uint256) {
	uint256 totalAmount = defiGetTotalRewardBalance();
	if (totalAmount == 0) return 0;
	uint256 totalResidence = GameSetting.getTotalResidence();

---

This issue was generated by todo-issue based on a TODO comment in 31fb99f. It's been assigned to @singyiu because they committed the code.

design reward distribution mechanism among players, i.e. depends on players' buildings

for now, calculate the distribution off chain and use this call to distribute reward to a specific player account

---

laputa/packages/contracts/src/systems/MockSystem.sol

Lines 28 to 33 in bb809a0

	//TODO: design reward distribution mechanism among players, i.e. depends on players' buildings
	//for now, calculate the distribution off chain and use this call to distribute reward to a specific player account
	function mockReleaseRewardToPlayer(address account, uint256 amount) public {
	ILapuVault lapuVault = ILapuVault(GameSetting.getLapuVaultAddress());
	lapuVault.transfer(account, amount);
	uint256 currentTotalRewarded = GameSetting.getTotalRewarded();

---

This issue was generated by todo-issue based on a TODO comment in bb809a0. It's been assigned to @Cygnusfear because they committed the code.

GameLoaded logic breaks when the map has zero entities

laputa/packages/client/src/game/systems/gameLoop.tsx

Lines 47 to 52 in 8aad88d

	// TODO: GameLoaded logic breaks when the map has zero entities [bug]
	for (const facility of facilities) {
	const { entity, typeId, position } = facility;
	if (!getEntityByPosition(position)) {
	const building = Object.values(EntityData.facilities).find(
	(f) => f.entityTypeId === typeId || ""

---

This issue was generated by todo-issue based on a TODO comment in 8aad88d. It's been assigned to @Cygnusfear because they committed the code.

consume resources from sender to build facility

laputa/packages/contracts/src/systems/FacilitySystem.sol

Lines 64 to 67 in cd23e95

	//TODO: consume resources from sender to build facility
	//create entity and assign component values
	bytes32 entityKey = positionToEntityKey(x, y, z);

---

This issue was generated by todo-issue based on a TODO comment in cd23e95. It's been assigned to @singyiu because they committed the code.

Extract build conditions, can't build 1 tile below gravity well, only gravity well can build at y==1, etc

laputa/packages/client/src/game/systems/constructionSystem.tsx

Lines 9 to 14 in d118bea

	// TODO: Extract build conditions, can't build 1 tile below gravity well, only gravity well can build at y==1, etc
	const canBuildAtPosition = (position: Vector3) => {
	const {
	input: { building },
	} = getState();
	if (position.y < 0) return false;

---

This issue was generated by todo-issue based on a TODO comment in d118bea. It's been assigned to @Cygnusfear because they committed the code.

extract input logic from construction system

Should accept a building type as arg

---

laputa/packages/client/src/game/systems/constructionSystem.tsx

Lines 21 to 26 in 2261ebc

	// TODO: extract input logic from construction system [refactor]
	// Should accept a building type as arg
	const buildFacility = (position: Vector3) => {
	const {
	input: { cursor, building, setInput },
	world: { addEntity },

---

This issue was generated by todo-issue based on a TODO comment in 2261ebc. It's been assigned to @singyiu because they committed the code.

webhook test

Camera movement & interaction / Playtest notes

• #20
• Hold shift to build more, or don't clear building by default
• Default camera position button

Vegetation instances clip at certain camera angles

Build basic facility construction features and save data in Zustand

Remove the face highlighting completely, or use alternative face highlighting like in Townscraper

laputa/packages/client/src/game/entities/facility.tsx

Lines 82 to 87 in d8fab95

	// TODO: Remove the face highlighting completely, or use alternative face highlighting like in Townscraper
	opacity={0}
	blending={AdditiveBlending}
	side={DoubleSide}
	/>
	))}

---

This issue was generated by todo-issue based on a TODO comment in d8fab95. It's been assigned to @Cygnusfear because they committed the code.