AnyRPG Core Documentation

repository·master·Indexed 21 days ago

https://github.com/anyrpg/anyrpgcore

A C#-based Role Playing Game engine for Unity designed for rapid creation of adventures, scenarios, and full games. Includes guides for installation via GitHub or the Unity Asset Store, engine initialization using the Welcome Window, and tools like SkyboxBlender for blending skybox materials.

Tokens
879
Snippets
3
Records
7
Agent score
26%

What's inside AnyRPG Core

  1. Get Started with AnyRPG in Unity

    master

    Once AnyRPG is installed in your Unity project, follow these steps to initialize the engine and begin creating content:

    1. Open Welcome Window: In the Unity Editor, navigate to the top menu and select Tools > AnyRPG > Welcome Window.
    2. Import Resources: In the Welcome Window, click the 'Import TMP Essential Resources' button to ensure TextMeshPro is correctly configured.

    From the Welcome Window, you can:

    • Sample Games: Find and open included sample games to see how the engine is used.
    • New Game Wizard: Launch the wizard to set up a new game project from scratch.
    • Support: Access online support resources for in-depth documentation and help.
    // Navigate via Unity Editor Menu:
    // Tools -> AnyRPG -> Welcome Window
  2. Install AnyRPG Core via GitHub

    master

    To install AnyRPG Core by cloning the repository, follow these steps:

    1. Install Unity: Ensure you have the correct Unity version installed. The current project uses Unity 6000.3.10f1.
    2. Clone Repository: Clone the anyrpg/anyrpg/anyrpgcore repository into a local directory.
    3. Add to Unity Hub: Open Unity Hub and add the cloned project directory to your workspace.

    A video tutorial for this method is available at: https://youtu.be/o_3pCpv4RHw

    # No specific CLI commands provided, follow manual steps above
  3. Set up SkyboxBlender to blend skyboxes in Unity

    master

    Use the SkyboxBlender.cs tool to blend two skybox materials with real-time environment lighting and reflection updates.

    Setup Steps:

    1. Attach the SkyboxBlender.cs script to an object in your Unity scene.
    2. Assign your two source skybox materials to the corresponding input fields on the SkyboxBlender component.
    3. Create a new material using the SkyboxBlender/BlendedSkybox shader.
    4. Assign this new material to both the SkyboxBlender component and your scene's Skybox (via Lighting settings).

    Requirements:

    • The input skybox materials must use the Unity built-in Skybox/6-sided shader.
    1. Add SkyboxBlender.cs to an object
    2. Assign two input skybox materials
    3. Create material with SkyboxBlender/BlendedSkybox shader
    4. Assign new material to SkyboxBlender and scene skybox