- 🎨 Advanced Syntax Highlighting: A clean and readable preview for all supported languages, compatible with Unity's Light and Dark themes.
- 📄 Rendered Markdown Preview: View your
.md(README) files rendered directly in the inspector for a much more pleasant reading experience. - 🔍 Powerful Navigation: Instantly find what you need with a built-in search tool that highlights all matches. Jump to any line number with the
Go to Linefeature. - 📊 Detailed Insights: Get a complete overview of your file: line, word, and character counts, file size, and last modification date.
- 🧠 Smart Header: Automatically detects and displays the script type (
MonoBehaviour,ScriptableObject, etc.) for immediate context. - ⚙️ Highly Customizable: Adjust the font size, preview height, and other display options in a polished foldout menu.
- ⚡ Quick Actions: A handy toolbar to edit the script in your IDE, ping the file, copy its path, or copy its entire content.
Choose your preferred installation method below. The recommended method is via Git URL.
1. Install via Unity Asset Store (Recommended)
This is the easiest way to install and receive updates.
- Open the CodePreview page on the Unity Asset Store and click "Add to My Assets".
- In your Unity project, open the Package Manager (
Window > Package Manager). - In the Package Manager window, select the "Packages: My Assets" view from the top-left dropdown menu.
- Find CodePreview in the list and click the "Import" button.
2. Install via Git URL
This method installs the package directly from GitHub and allows you to update it easily.
- In Unity, open the Package Manager (
Window > Package Manager). - Click the + button and select "Add package from git URL...".
- Enter the following URL and click "Add":
https://github.com/Alaxxxx/CodePreview.git
2. Install via .unitypackage
Ideal if you prefer a specific, stable version of the asset.
- Go to the Releases page.
- Download the
.unitypackagefile from the latest release. - In your Unity project, go to
Assets > Import Package > Custom Package...and select the downloaded file.
3. Manual Installation (from .zip)
- Download this repository as a ZIP file by clicking
Code > Download ZIP. - Unzip the file.
- Drag the unzipped package folder into your project's
Assetsdirectory.
This project is open-source under the MIT License, and any form of contribution is welcome and greatly appreciated!
If you find CodePreview useful in your workflow, the easiest way to show your support is by giving it a star ⭐️ on GitHub! It helps a lot with the project's visibility and motivates me to keep improving it.
Here are other ways you can get involved:
- 💡 Share Ideas & Report Bugs: Have a great idea for a new feature, a supported language, or found a bug? Open an issue to share the details.
- 🔌 Contribute Code: Feel free to fork the repository and submit a pull request for bug fixes or new features.
- 🗣️ Spread the Word: Know other Unity developers? Share this tool with them!
Every contribution, from a simple star to a pull request, is incredibly valuable. Thank you for your support!
