Skip to content

README.md

Latest commit

 

History

History
99 lines (75 loc) · 3.51 KB

README.md

File metadata and controls

99 lines (75 loc) · 3.51 KB

Utils

Pure utility functions for encoding, JSON generation, and token metadata rendering. All functions are stateless with no storage or syscalls.

Modules

Module Purpose
encoding Base64 encoding, byte counting utilities
json JSON generation for settings, objectives, context metadata
renderer SVG/HTML rendering for token metadata and token_uri

Encoding

use game_components_utils::encoding::bytes_base64_encode;

// Base64 encode any ByteArray
let encoded = bytes_base64_encode("Hello World");
// Result: "SGVsbG8gV29ybGQ="

// Byte counting for integer types
use game_components_utils::encoding::U256BytesUsedTraitImpl;
let bytes_needed = U256BytesUsedTraitImpl::bytes_used(some_value.into());

BytesUsedTrait implementations: u8, usize, u64, u128, u256

JSON

Generates JSON strings for game metadata components.

use game_components_utils::json::{
    create_settings_json, create_objectives_json,
    create_context_json, create_json_array,
};

// Settings JSON
let settings = array![
    GameSetting { name: "Difficulty", value: "Hard" },
    GameSetting { name: "Lives", value: "3" },
].span();
let json = create_settings_json("Mode Name", "Mode Description", settings);
// {"Name":"Mode Name","Description":"Mode Description","Settings":{"Difficulty":"Hard","Lives":"3"}}

// Objectives JSON
let objectives = array![
    GameObjective { name: "Score 100", value: "100 points" },
].span();
let json = create_objectives_json(objectives);

// Context JSON (with optional context_id)
let contexts = array![
    GameContext { name: "Tournament", value: "Weekly #5" },
].span();
let json = create_context_json("Budokan", "Tournament system", Option::Some(42), contexts);

// Simple JSON array
let values = array!["value1", "value2"].span();
let json = create_json_array(values);  // ["value1","value2"]

Renderer

Generates data URIs for token metadata and SVG images.

use game_components_utils::renderer::{create_default_svg, create_custom_metadata};

// Default SVG with animated game card design
let svg_uri = create_default_svg(
    game_metadata, token_metadata, score, player_name,
    settings_details, objective_details, context_details,
);
// Result: "data:image/svg+xml;base64,..."

// Full custom metadata with all extensions
let metadata_uri = create_custom_metadata(
    token_id, token_name, token_description,
    game_metadata, game_details_image, game_details,
    settings_details, context_details, token_metadata,
    score, minted_by, player_name, objective_name,
);
// Result: "data:application/json;base64,..."

SVG features: 470x600 pixel animated game card with cyberpunk/dark-tech aesthetic, pinstripe background, animated gradient border and shimmer, status badge pills (ACTIVE/FINISHED, SOULBOUND, OBJ DONE/PENDING), two-column panels with accent left-borders, timeline progress bar with datetimes, context section with key:value pairs, SVG icon symbols, and game color accent throughout.

Metadata JSON includes: Standard NFT fields (name, description, image), game traits (game_id, developer, minted_by, score), lifecycle traits (minted_time, start_time, end_time, expired), optional traits (settings, context, objectives).

Dependencies

  • graffiti - JSON building
  • alexandria_encoding - Base64 encoding
  • game_components_metagame - GameContext structs
  • game_components_minigame - GameSetting, GameObjective structs
  • game_components_registry - GameMetadata struct
  • game_components_token - TokenMetadata struct