Wiki
  • Homepage
  • Player's Manual
    • Controls
    • Skills
    • Objects
    • Credits
  • Contributing
    • Getting Started
      • Programs and Files
      • Cloning the GitHub Project
      • Git Structure
      • Submitting Changes
    • Level Design
      • Basic Level Setup
      • Creating Static.tscn
      • Creating Collision.tscn
      • Stage Triggers
        • Using StageTrigger.tscn
        • Camera Triggers
        • Culling Triggers
        • Death Triggers
        • Dialog Triggers
        • Jump Triggers
        • Path Triggers
        • Automation Triggers
        • Drift Triggers
        • Foothold Triggers
        • Platform Triggers
        • Sidle Triggers
      • Stage Objects
      • Placing Objects Along the Path
    • Playtesting
      • General Shortcuts
      • Debug Menu
      • Free Camera Mode
      • Using the Editor for Playtesting
    • Submitting a Bug Report
    • Documentation Style Guide
  • Asset Guidelines
    • Source Files
    • Asset Ripping Reference
      • Original Model Files
    • Asset Editing Reference
      • Editing Environment Models
      • Editing Collision Models
      • All About Curves
      • Exporting Models from Blender
    • Resources Files
      • CameraSettingsResource
    • Miscellaneous Notes
  • Godot Guidelines
    • File Guides
      • File Structure
      • Naming Files
    • Project Settings
      • Tag Reference
      • Layer Reference
    • Particle Effects
    • Audio
  • CODE GUIDELINES
    • Language Specifications
    • Formatting
    • General guidelines
    • Attributes
    • Floating Point Numbers
Powered by GitBook
On this page
  1. Contributing
  2. Getting Started

Cloning the GitHub Project

PreviousPrograms and FilesNextGit Structure

Last updated 10 months ago

Before you can make any contributions to the project, you'll first need to set up a local copy of the GitHub project.

  1. Make sure you've downloaded the .

  2. Open GitHub Desktop and sign in with your GitHub account.

  3. Select "File -> Clone Repository -> URL."

  4. Enter Kuma-Boo/project-reignition and save the repository in a sensible location.

  5. Select Clone and wait for the process to complete.

  6. After importing the project in Godot, wait for the game files to import. You may need to unfocus and refocus the Godot window to complete the importing process.

  7. In Godot's file browser, search for .gltf, select everything, [Right Click] and select "Reimport."

  8. In Github Desktop, select all the changed files with [Ctrl + A], [Right Click] and select "Discard All Changes."

  9. Build the project, then enable all the plugins in Project Settings -> Plugins if they are not already enabled.

Troubleshooting

  • Github gets stuck/fails when cloning the project!

    • Retry cloning at a later time.

  • When I open the project in Godot, I get a bunch of errors.

    • This is normal and will fix itself once you build the project. Simply close out any errors that appear and continue following the steps listed above.

  • I don't see the reimport option when selecting the .gltf files.

    • Click the square icon in the upper right corner of file system so it excludes folders, then try again.

  • Videos are missing.

    • This is normal. Due to their size, video files are a separate optional download. If you want to fix this, download this file and extract it into the project. The "stream" folder should be in the project's existing "video" folder. Cutscenes are being reworked into the mp4 format for more quality and downloads for it are unavailable at the moment.

  • All/Some of my level textures are missing!

    • You may need to repeat step 7.

  • Sonic isn't animating properly and is stuck in a T-Pose.

    • You may need to repeat step 8.

project prerequisites