[WIP] Restructure docs into manual/development and add implementation docs#94
Draft
NtskwK wants to merge 8 commits intoHydroRoll-Team:mainfrom
Draft
[WIP] Restructure docs into manual/development and add implementation docs#94NtskwK wants to merge 8 commits intoHydroRoll-Team:mainfrom
NtskwK wants to merge 8 commits intoHydroRoll-Team:mainfrom
Conversation
|
@NtskwK is attempting to deploy a commit to the retrofor Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Reviewer's GuideRefactors feature documentation to be more user-focused by removing low-level code snippets and linking to newly added technical implementation pages, updates docs UI card styling, and introduces detailed Internal Implementation docs (English and Chinese) for core systems like authentication, Java management, mod loaders, and event architecture. Sequence diagram for Forge installation via official installersequenceDiagram
actor User
participant Frontend as Frontend_UI
participant Backend as Tauri_Backend
participant ForgeMaven as Forge_Maven_Repo
participant Java as Local_Java_Runtime
User->>Frontend: choose_install_forge(version)
Frontend->>Backend: invoke install_forge(minecraft_version, forge_version)
Backend->>ForgeMaven: resolve_installer_coordinates
ForgeMaven-->>Backend: installer_url
Backend->>ForgeMaven: download_installer(installer_url)
ForgeMaven-->>Backend: forge_installer_jar
Backend-->>Frontend: mod_loader_progress downloading
Backend->>Java: spawn_process
Java-->>Backend: process_started
Backend->>Java: run_installer_jar_with_installClient(game_dir)
Backend-->>Frontend: mod_loader_progress installing
Java-->>Backend: writes_version_json_and_libraries
Backend->>Backend: parse_generated_version_json
Backend->>Backend: update_internal_version_index
Backend-->>Frontend: mod_loader_progress processing
Backend-->>Frontend: mod_loader_progress complete
Frontend-->>User: show_forge_installed_success(version)
Entity relationship diagram for accounts and Java catalog dataerDiagram
AccountsStore {
string active_account_uuid
}
Account {
string uuid
string type
string username
string access_token
string refresh_token
int expires_at
}
JavaCatalog {
int cached_at
}
JavaRelease {
int major_version
string image_type
string version
string download_url
string checksum
int file_size
}
AccountsStore ||--o{ Account : contains
JavaCatalog ||--o{ JavaRelease : includes
Updated class diagram for core state and version structuresclassDiagram
class AuthState {
Account currentAccount
bool isLoginModalOpen
AuthState()
void setCurrentAccount(Account account)
void openLoginModal()
void closeLoginModal()
}
class UIState {
string activeView
UIState()
void setView(string view)
}
class Account {
string uuid
string type
string username
string accessToken
string refreshToken
int expiresAt
}
class JavaInstallation {
string path
string version
int major
bool is64Bit
JavaInstallation(string path, string version, int major, bool is64Bit)
}
class JavaRelease {
int majorVersion
string imageType
string version
string downloadUrl
string checksum
int fileSize
}
class JavaCatalog {
JavaRelease releases
int cachedAt
JavaCatalog()
void addRelease(JavaRelease release)
JavaRelease findBestRelease(int majorVersion, string imageType)
}
class GameVersion {
string id
string inheritsFrom
string mainClass
Library libraries
string jvmArguments
string gameArguments
GameVersion()
}
class Library {
string name
string url
Library(string name, string url)
}
class MavenCoordinate {
string group
string artifact
string version
string extension
MavenCoordinate(string group, string artifact, string version, string extension)
string toPath()
}
class VersionMerger {
VersionMerger()
GameVersion mergeVersions(GameVersion child, GameVersion parent)
}
class EventBus {
EventBus()
void emitLauncherLog(string message)
void emitGameStdout(string line)
void emitGameStderr(string line)
void emitAuthProgress(string stage)
void emitModLoaderProgress(string stage)
void emitJavaDownloadProgress(int percent, int speed, int eta)
}
AuthState --> Account
JavaCatalog --> JavaRelease
GameVersion --> Library
VersionMerger --> GameVersion
MavenCoordinate --> Library
EventBus --> AuthState
EventBus --> UIState
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
|
@SourceryAI title |
Member
Author
|
cc @BegoniaHe |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Refine user-facing documentation around mod loaders, authentication, and Java management, introduce detailed internal implementation docs, and adjust docs/home page styling for a more consistent visual presentation.
Enhancements:
Documentation: