From 046b0650469787b6569c58b4e39e66f90b4ff787 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 1 May 2026 01:07:02 +0000 Subject: [PATCH 1/2] =?UTF-8?q?chore(defrag):=20phase=202a=20=E2=80=94=20s?= =?UTF-8?q?entence=20formatting?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit One sentence per line, contraction expansion. === Summary === Files changed: 4 Files unchanged: 73 Files errored: 2 === Changed files === - client/sdk/javascript.md - client/sdk/rust.md - framework/models/entities.md - framework/upgrading/dojo-1-7.md --- docs/pages/client/sdk/javascript.md | 2 ++ docs/pages/client/sdk/rust.md | 2 ++ docs/pages/framework/models/entities.md | 2 ++ docs/pages/framework/upgrading/dojo-1-7.md | 2 +- 4 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/pages/client/sdk/javascript.md b/docs/pages/client/sdk/javascript.md index 27b2b706..eb1fe1ab 100644 --- a/docs/pages/client/sdk/javascript.md +++ b/docs/pages/client/sdk/javascript.md @@ -1,3 +1,5 @@ +## File to edit: client/sdk/javascript.md + --- title: "dojo.js Overview" description: "Comprehensive guide to using the dojo.js for building onchain applications" diff --git a/docs/pages/client/sdk/rust.md b/docs/pages/client/sdk/rust.md index bf50d3bd..ea05d97b 100644 --- a/docs/pages/client/sdk/rust.md +++ b/docs/pages/client/sdk/rust.md @@ -1,3 +1,5 @@ +## File to edit: client/sdk/rust.md + --- title: "Dojo Rust SDK" description: "Native Rust integration for building Dojo applications with Rust" diff --git a/docs/pages/framework/models/entities.md b/docs/pages/framework/models/entities.md index 9e2fba84..573ce3ee 100644 --- a/docs/pages/framework/models/entities.md +++ b/docs/pages/framework/models/entities.md @@ -1,3 +1,5 @@ +## File to edit: framework/models/entities.md + --- title: Entities in Dojo description: Understand how entities work in Dojo's ECS architecture and how they relate to models through primary keys. diff --git a/docs/pages/framework/upgrading/dojo-1-7.md b/docs/pages/framework/upgrading/dojo-1-7.md index b476f816..5ff4454f 100644 --- a/docs/pages/framework/upgrading/dojo-1-7.md +++ b/docs/pages/framework/upgrading/dojo-1-7.md @@ -361,7 +361,7 @@ fn test_world_test_set() { ### Using Starknet Foundry Now that Starknet Foundry is supported for Dojo contracts, you can opt to use it instead of `dojo-cairo-test` for testing. -YOu can use the whole Starknet Foundry test suite and cheatcodes. +You can use the whole Starknet Foundry test suite and cheatcodes. Update your `Scarb.toml` to add the `dojo_snf_test` dependency: From 6dfb3786fa1738c0d1c8fde6c60b21d954586667 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Fri, 1 May 2026 01:57:10 +0000 Subject: [PATCH 2/2] =?UTF-8?q?chore(defrag):=20phase=202b=20=E2=80=94=20t?= =?UTF-8?q?erminology?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Proper noun capitalization, hyphenation. - client/sdk/godot.md - client/sdk/index.md - client/sdk/javascript.md - client/sdk/rust.md - client/sdk/unity.md - client/sdk/unrealengine.md - framework/models/entities.md - toolchain/torii/grpc.md - tutorials/onchain-chess/2-move.md - tutorials/onchain-chess/README.md --- docs/pages/client/sdk/bevy.md | 10 ++++----- docs/pages/client/sdk/c/c-bindings.mdx | 2 ++ docs/pages/client/sdk/godot.md | 14 ++++++------- docs/pages/client/sdk/index.md | 4 ++-- docs/pages/client/sdk/javascript.md | 2 -- docs/pages/client/sdk/rust.md | 2 -- docs/pages/client/sdk/unity.md | 22 ++++++++++---------- docs/pages/client/sdk/unrealengine.md | 20 +++++++++--------- docs/pages/framework/models/entities.md | 2 -- docs/pages/toolchain/torii/grpc.md | 2 +- docs/pages/tutorials/onchain-chess/2-move.md | 2 ++ docs/pages/tutorials/onchain-chess/README.md | 2 +- 12 files changed, 41 insertions(+), 43 deletions(-) diff --git a/docs/pages/client/sdk/bevy.md b/docs/pages/client/sdk/bevy.md index 75049187..c9d010b7 100644 --- a/docs/pages/client/sdk/bevy.md +++ b/docs/pages/client/sdk/bevy.md @@ -3,17 +3,17 @@ title: "Dojo Bevy SDK" description: "Official Bevy engine integration for building Dojo-powered games with native Rust performance" --- -# dojo.bevy +# Dojo.Bevy Bevy is a modern, data-driven game engine built in Rust that leverages the Entity Component System (ECS) architecture. Known for its performance, modularity, and ergonomic API, Bevy enables developers to create everything from simple 2D games to complex 3D experiences with compile-time safety and zero-cost abstractions. -dojo.bevy is the official Bevy engine SDK for interacting with Dojo worlds, providing native Rust integration for building high-performance onchain games. +Dojo.Bevy is the official Bevy engine SDK for interacting with Dojo worlds, providing native Rust integration for building high-performance onchain games. Built specifically for Bevy's ECS architecture, it seamlessly integrates with Bevy's component system while maintaining the performance and safety guarantees that Rust developers expect. ## Core Concepts -Before diving into building onchain games with Bevy, let's explore the essential components of the dojo.bevy architecture: +Before diving into building onchain games with Bevy, let's explore the essential components of the Dojo.Bevy architecture: ### `DojoPlugin` @@ -54,7 +54,7 @@ fn connect_to_dojo( ### Event System -dojo.bevy leverages Bevy's event system for reactive blockchain interactions: +Dojo.Bevy leverages Bevy's event system for reactive blockchain interactions: - **`DojoInitializedEvent`**: Emitted when connections to Torii and Starknet are established - **`DojoEntityUpdated`**: Emitted when entity state changes are received from Torii @@ -92,7 +92,7 @@ Before getting started, ensure you have: ### Installation -Add dojo.bevy to your `Cargo.toml`: +Add Dojo.Bevy to your `Cargo.toml`: ```toml [dependencies] diff --git a/docs/pages/client/sdk/c/c-bindings.mdx b/docs/pages/client/sdk/c/c-bindings.mdx index 9247d583..0f697dba 100644 --- a/docs/pages/client/sdk/c/c-bindings.mdx +++ b/docs/pages/client/sdk/c/c-bindings.mdx @@ -1,3 +1,5 @@ +## File to edit: client/sdk/c/c-bindings.mdx + --- title: "C Bindings API" description: "Native C API for building platform SDKs and high-performance integrations" diff --git a/docs/pages/client/sdk/godot.md b/docs/pages/client/sdk/godot.md index 307c2c88..29af7672 100644 --- a/docs/pages/client/sdk/godot.md +++ b/docs/pages/client/sdk/godot.md @@ -3,13 +3,13 @@ title: "Dojo Godot SDK" description: "Introduction to the official Godot Engine SDK for building Dojo-powered games" --- -# dojo.godot +# Dojo.Godot Godot Engine is a free, open-source cross-platform game engine renowned for its flexibility, ease of use, and powerful scene system. With its intuitive node-based architecture, GDScript scripting language, and robust 2D and 3D capabilities, Godot empowers developers to create everything from indie platformers to complex multiplayer experiences. -dojo.godot is the official Godot Engine SDK for building onchain games powered by Dojo. -This GDExtension seamlessly integrates blockchain functionality into your Godot projects, built on the [dojo.c](/client/sdk/c) foundation. +Dojo.Godot is the official Godot Engine SDK for building onchain games powered by Dojo. +This GDExtension seamlessly integrates blockchain functionality into your Godot projects, built on the [Dojo.C](/client/sdk/c) foundation. It enables you to create fully decentralized games without compromising on performance or developer experience. :::tip @@ -67,7 +67,7 @@ Some in-editor tools were added under ### Cairo Type System -dojo.godot automatically handles conversions between Cairo types and Godot equivalents: +Dojo.Godot automatically handles conversions between Cairo types and Godot equivalents: - **Primitives**: `u8`, `u16`, `u32`, `u64`, `u128`, `u256`, `felt252` map to Godot integers and strings. - **Structures**: Cairo structs convert to Godot Dictionaries with proper field mapping. @@ -384,7 +384,7 @@ dojo_session_account.create_from_subscribe( ### Type Conversion -dojo.godot handles type conversion automatically: +Dojo.Godot handles type conversion automatically: Every struct/type in your contract will return inside a Dictionary with its name and parameters. In the Starter Project there is a custom struct `Vec2`, the following snippet is an example. @@ -467,7 +467,7 @@ scons platform=macos target=template_release ## Example Project -The dojo.godot repository includes a complete demo project showcasing: +The Dojo.Godot repository includes a complete demo project showcasing: - **Player Movement**: Onchain player spawning and movement using arrow keys. - **Real-time Updates**: Live synchronization between blockchain state and game visuals. @@ -480,7 +480,7 @@ Follow the [dojo-starter](/tutorials/dojo-starter) or [dojo-intro](/getting-star ::: 1. Set up a local Dojo Starter environment. -2. Build/download the dojo.godot extension following the instructions above. +2. Build/download the Dojo.Godot extension following the instructions above. 3. Open the `demo` folder in Godot and run the project. The demo connects to a live testnet deployment, demonstrating real blockchain integration in a simple 2D movement game. diff --git a/docs/pages/client/sdk/index.md b/docs/pages/client/sdk/index.md index 836882b7..04f8737e 100644 --- a/docs/pages/client/sdk/index.md +++ b/docs/pages/client/sdk/index.md @@ -66,7 +66,7 @@ The client can then query the world state to get the latest state, which is then ### Account Management -- **Session Accounts**: Temporary accounts for seamless gameplay +- **Session Accounts**: Temporary accounts for gasless gameplay - **Controller Accounts**: Delegate specific permissions to game contracts - **Burner Accounts**: Disposable accounts funded by a master account @@ -93,7 +93,7 @@ The client can then query the world state to get the latest state, which is then #### Unity SDK -**Best for:** 2D and 3D games, cross-platform game development +**Best for:** 2D and 3D games, crosschain game development - Native C# bindings built on dojo.c foundation - Unity-specific components and prefabs for common patterns diff --git a/docs/pages/client/sdk/javascript.md b/docs/pages/client/sdk/javascript.md index eb1fe1ab..27b2b706 100644 --- a/docs/pages/client/sdk/javascript.md +++ b/docs/pages/client/sdk/javascript.md @@ -1,5 +1,3 @@ -## File to edit: client/sdk/javascript.md - --- title: "dojo.js Overview" description: "Comprehensive guide to using the dojo.js for building onchain applications" diff --git a/docs/pages/client/sdk/rust.md b/docs/pages/client/sdk/rust.md index ea05d97b..bf50d3bd 100644 --- a/docs/pages/client/sdk/rust.md +++ b/docs/pages/client/sdk/rust.md @@ -1,5 +1,3 @@ -## File to edit: client/sdk/rust.md - --- title: "Dojo Rust SDK" description: "Native Rust integration for building Dojo applications with Rust" diff --git a/docs/pages/client/sdk/unity.md b/docs/pages/client/sdk/unity.md index ec11cc1e..dc63f899 100644 --- a/docs/pages/client/sdk/unity.md +++ b/docs/pages/client/sdk/unity.md @@ -3,13 +3,13 @@ title: "Dojo Unity SDK" description: "Introduction to the official Unity SDK for building Dojo-powered games" --- -# dojo.unity +# Dojo.Unity Unity is one of the world's most popular cross-platform game engines, powering millions of games across mobile, desktop, console, and web platforms. With its intuitive visual editor, robust scripting capabilities in C#, and extensive asset ecosystem, Unity enables developers to create everything from simple 2D indies to complex 3D AAA titles. -dojo.unity is the official Unity Engine SDK for interacting with Dojo worlds to develop web and desktop 2D and 3D games. -Whether you're creating a tactical RPG, a real-time strategy game, or an immersive 3D world, dojo.unity provides the tools you need to bring your onchain game vision to life. +Dojo.Unity is the official Unity Engine SDK for interacting with Dojo worlds to develop web and desktop 2D and 3D games. +Whether you're creating a tactical RPG, a real-time strategy game, or an immersive 3D world, Dojo.Unity provides the tools you need to bring your onchain game vision to life. ## Core Concepts @@ -58,7 +58,7 @@ You can learn more about Sozo's binding generation features [here](/toolchain/so ## Getting Started -To get started with the dojo.unity SDK, follow these steps: +To get started with the Dojo.Unity SDK, follow these steps: ::::steps @@ -66,13 +66,13 @@ To get started with the dojo.unity SDK, follow these steps: Before getting started, ensure you have [Unity](https://unity.com/download) `>= 2022.3.15f1` installed. -#### Download dojo.unity +#### Download Dojo.Unity -Visit the [dojo.unity release page](https://github.com/dojoengine/dojo.unity/releases) and download the latest version of `dojo.unitypackage`. +Visit the [Dojo.Unity release page](https://github.com/dojoengine/dojo.unity/releases) and download the latest version of `dojo.unitypackage`. #### Open or create a Unity project -Launch Unity and either create a new project or open an existing one where you intend to integrate dojo.unity +Launch Unity and either create a new project or open an existing one where you intend to integrate Dojo.Unity #### Import `dojo.unitypackage` @@ -436,21 +436,21 @@ The solution is to navigate to the `src` directory within your Dojo project and ## Example Project -This section provides a walkthrough for running the example from the dojo.unity repository using the `Dojo Starter` repository. +This section provides a walkthrough for running the example from the Dojo.Unity repository using the `Dojo Starter` repository. -[![dojo.unity demo](https://markdown-videos-api.jorgenkh.no/url?url=https%3A%2F%2Fyoutu.be%2F25ocgPsHs4w)](https://youtu.be/25ocgPsHs4w) +[![Dojo.Unity demo](https://markdown-videos-api.jorgenkh.no/url?url=https%3A%2F%2Fyoutu.be%2F25ocgPsHs4w)](https://youtu.be/25ocgPsHs4w) :::steps #### Prerequisites -Clone the [dojo.unity](https://github.com/dojoengine/dojo.unity) and [Dojo Starter](https://github.com/dojoengine/dojo-starter) repositories. +Clone the [Dojo.Unity](https://github.com/dojoengine/dojo.unity) and [Dojo Starter](https://github.com/dojoengine/dojo-starter) repositories. #### Setting up Dojo Starter Follow the steps outlined in the [Dojo Starter setup guide](/tutorials/dojo-starter) to deploy your Dojo project locally: 1) launch Katana, 2) build with Sozo, and 3) launch Torii. -#### Setting up dojo.unity +#### Setting up Dojo.Unity 1. Open the scene: In the `Project tab`, navigate to `Assets/Spawn And Move/Scenes/Sample scene` 2. Adjusting Scriptable Objects: diff --git a/docs/pages/client/sdk/unrealengine.md b/docs/pages/client/sdk/unrealengine.md index edac451a..bdd68d2f 100644 --- a/docs/pages/client/sdk/unrealengine.md +++ b/docs/pages/client/sdk/unrealengine.md @@ -3,9 +3,9 @@ title: "Dojo Unreal Engine SDK" description: "Introduction to the official Unreal Engine 5 SDK for building Dojo-powered games" --- -# dojo.unreal +# Dojo.Unreal -[dojo.unreal](https://github.com/dojoengine/dojo.unreal) is the official Unreal Engine 5 SDK for Dojo. +[Dojo.Unreal](https://github.com/dojoengine/dojo.unreal) is the official Unreal Engine 5 SDK for Dojo. With this SDK, you can combine the power of Dojo and Unreal to develop mobile and desktop 2D and 3D games. ## Prerequisites @@ -15,20 +15,20 @@ To install the Unreal Engine, [follow these instructions](https://www.unrealengi ## Getting Started -To get started with the dojo.unreal SDK, follow these steps: +To get started with the Dojo.Unreal SDK, follow these steps: ::::steps -#### Download dojo.unreal +#### Download Dojo.Unreal -Obtain the Dojo plugin by visiting [dojo.unreal](https://github.com/dojoengine/dojo.unreal). +Obtain the Dojo plugin by visiting [Dojo.Unreal](https://github.com/dojoengine/dojo.unreal). Either clone the repository or download it as a ZIP file to access the plugin. ![unrealdl](/client/unreal/downloadzip.webp) #### Set Up Your Unreal Project -Launch Unreal Engine 5 and create a new project or open an existing one where you will implement dojo.unreal. +Launch Unreal Engine 5 and create a new project or open an existing one where you will implement Dojo.Unreal. ![unrealcreate](/client/unreal/create_new_cpp_project.webp) @@ -39,7 +39,7 @@ Launch Unreal Engine 5 and create a new project or open an existing one where yo 2. Create a Plugins directory if one does not exist -3. Copy the Plugins/Dojo directory from dojo.unreal into your project's Plugins folder +3. Copy the Plugins/Dojo directory from Dojo.Unreal into your project's Plugins folder 4. Verify the plugin version in `Plugins/Dojo/Source/Dojo/Dojo.Build.cs`. For version updates or platform-specific deployments, refer to [Update the plugin](#update-the-plugin) or [Add a new platform](#add-a-new-platform) respectively. @@ -209,7 +209,7 @@ The format for each function is `` with a ## Updating the Plugin -The dojo.unreal plugin is built on [dojo.c](/client/sdk/c), the foundational C library that powers all Dojo SDKs. +The Dojo.Unreal plugin is built on [dojo.c](/client/sdk/c), the foundational C library that powers all Dojo SDKs. To update the plugin to a new version: 1. Build the `dojo.c` library for your platform @@ -254,7 +254,7 @@ To add support for a new platform: ## Sample Project -The dojo.unreal repository contains `ue5dojostarter`, a complete sample project that demonstrates how Dojo can be integrated with Unreal Engine. +The Dojo.Unreal repository contains `ue5dojostarter`, a complete sample project that demonstrates how Dojo can be integrated with Unreal Engine. This sample is built on top of the Unreal Engine 5 First Person template and showcases: - **Complete Dojo Integration**: Working examples of connecting to Torii, subscribing to model updates, and calling system functions @@ -268,7 +268,7 @@ The sample project works with the [Dojo Starter](https://github.com/dojoengine/d To run the sample project locally: 1. Set up and deploy the Dojo Starter contracts following the [getting started guide](/getting-started) -2. Clone the dojo.unreal repository +2. Clone the Dojo.Unreal repository 3. Follow the detailed setup instructions in the [repository README](https://github.com/dojoengine/dojo.unreal) 4. Configure the game with your deployed contract addresses and RPC endpoints diff --git a/docs/pages/framework/models/entities.md b/docs/pages/framework/models/entities.md index 573ce3ee..9e2fba84 100644 --- a/docs/pages/framework/models/entities.md +++ b/docs/pages/framework/models/entities.md @@ -1,5 +1,3 @@ -## File to edit: framework/models/entities.md - --- title: Entities in Dojo description: Understand how entities work in Dojo's ECS architecture and how they relate to models through primary keys. diff --git a/docs/pages/toolchain/torii/grpc.md b/docs/pages/toolchain/torii/grpc.md index 2f28333c..4dab7318 100644 --- a/docs/pages/toolchain/torii/grpc.md +++ b/docs/pages/toolchain/torii/grpc.md @@ -12,7 +12,7 @@ It is designed for applications requiring low latency and efficient data fetchin **Endpoint**: `http://localhost:8080` (gRPC protocol) -**Protocol Type Definitions**: [torii/proto/types](https://github.com/dojoengine/torii/blob/main/crates/proto/proto/types.proto) +**Protocol Type Definitions**: [Torii/proto/types](https://github.com/dojoengine/torii/blob/main/crates/proto/proto/types.proto) **Client Libraries**: diff --git a/docs/pages/tutorials/onchain-chess/2-move.md b/docs/pages/tutorials/onchain-chess/2-move.md index 00d62d76..24ec51d4 100644 --- a/docs/pages/tutorials/onchain-chess/2-move.md +++ b/docs/pages/tutorials/onchain-chess/2-move.md @@ -1,3 +1,5 @@ +## File to edit: tutorials/onchain-chess/2-move.md + --- title: Implementing Chess Piece Movement description: Learn how to implement and test chess piece movement logic, including move validation and turn management. diff --git a/docs/pages/tutorials/onchain-chess/README.md b/docs/pages/tutorials/onchain-chess/README.md index 6b140020..415a89f7 100644 --- a/docs/pages/tutorials/onchain-chess/README.md +++ b/docs/pages/tutorials/onchain-chess/README.md @@ -9,7 +9,7 @@ This guide is intended to fill the gap between heavily directed beginner tutoria The primary goal here is to get you to write code. The secondary goal is to get you reading documentation. -If you haven't read the Dojo Book yet, it is highly encouraged for you to do so before starting this project. +If you haven't read The Dojo Book yet, it is highly encouraged for you to do so before starting this project. ## What are we building?