Skip to content

PCL-Community/PCL.Proto

Repository files navigation

PCL.Proto

| 中文版点我 |

PCL.Proto

With the rapid launch of PCL branch versions, UI restoration has become a major challenge for many developers. PCL.Proto emerges as a solution.

screenshot

This project is modeled after PCL2 and PCL2-CE, with a goal of providing a standardized prototype sample for each PCL branch version. The repository is built using Vue3, and if your project uses Webview as the frontend, you can directly reference this project.

The project is also ready for preview at PCL.Proto.

Prototype

If your PCL branch version or your custom launcher is not based on Web technology, referencing this repository directly might have limited convenience. You may head to js.design - 「PCL.Prototype」 to view the specific application prototype, export the cut image or refer to the style code generated by it.

In case you would like to modify the prototype design file, you are welcome to click this link to join the team.

Project Configuration

Prerequisites

  • First, please ensure that nodejs or bun is installed on your device. If you use npm as the package manager, you can replace all bun commands below with npm.
  • The device should have a usable rust toolchain installed. For Windows, the MSVC version of the toolchain is required. Additionally, ensure that you have installed the MSVC suite from the C++ development tools and the Windows SDK in the Visual Studio Installer. For macOS, make sure that Xcode is installed.

Note

If you have any questions, please refer to Prerequisites | Tauri.

Project Dependencies

After cloning this project, you need to run the following command to initialize the submodule:

git submodule update --init --recursive

Currently, the project is a Tauri + Vue3 + Vite project. Before running the project for the first time, please run the following command to install the front-end dependencies:

bun install

The backend dependencies will be managed by cargo automatically.

Then, use bun run tauri icon to automatically generate icons. You can then start the development and build processes.

Warning

The icons in this repository are excluded. Therefore, if you do not perform this step after cloning the repository, the icons folder will be empty, and the Tauri application will throw an error when it starts!

Hot Reload Development

bun run tauri dev

Build Tauri App

If only bun is installed on your device but nodejs is not installed, please change thebuild/foreBuildCommand content in src-auri/tauri.conf.json from bun run build to bun run build-only, which also needs to be modified when using npm.

HELP WANTED!!

I want to make this project into a Vue component npm package, but I don't know how to do it. If there are any experts who can do component libraries, please contact me! Thank you!

Credits

If I have seen further it is by standing on ye shoulder of Giants.
—— Sir Isaac Newton

Directed referenced projects

Vue.js
TypeScript
Pug
Vite
Vue Router
xml-js
Pinia
skinview3d
Bun
Rust Programming Language
Tauri

Implementation or design reference

Plain Craft Launcher
PCL2-CE
PCL.Neo
xphost008/MMCLL
Steve-xmh/scl

About

Modeled after PCL2 and PCL2-CE, with a goal of providing a standardized prototype sample for each PCL branch version.

Topics

Resources

License

Stars

Watchers

Forks