Skip to content

Documentation Update #320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nusiq merged 1 commit into from
Jan 19, 2025
Merged

Documentation Update #320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 10 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
</p>

<p align="center">
<b>⭐ <a href="https://bedrock-oss.github.io/regolith/">Visit the Website! ⇗</a> ⭐</b>
<b>⭐ <a href="https://regolith-docs.readthedocs.io/en/latest/">Go to the Documentation ⇗</a> ⭐</b>
</p>

- Much like `bridge. v2`, Regolith introduces the concept of a "project folder", where your addons are written, including the RP, the BP, and any models, textures or configuration files. This single-folder-structure is great for version control, and allows you to keep your "source-of-truth" outside of `com.mojang`.
Expand All @@ -19,30 +19,24 @@
## 🎫 Value Preposition

- Fundamentally, Regolith is nothing new. Many tools like this exist, such as the `bridge v2` plugin system, or even something like Gulp or SASS.

- The value preposition for Regolith is that it allows many tools, in many languages and pay-structures to work together in a single, unified compilation flow.

- Hobbiests can use the [Standard Library ⇗](https://github.com/Bedrock-OSS/regolith-filters), or write their own filters. Marketplace teams can write proprietary filters, or internal filters.


# 💻 Regolith Development

## 🎚 Setup:

**This setup is for developers. If you're a normal user, you can find simpler
instructions
[here](https://bedrock-oss.github.io/regolith/guide/installing).**
[here](https://regolith-docs.readthedocs.io/en/latest/introduction/installation/).**

### 1. Install Golang

- **[Installation and beginners guide ⇗.](https://golang.org/doc/tutorial/getting-started)**

### 2. Install Dependencies

- `go get -u ./...` to recursively install all dependencies.

### 3. Test / Run

Since Regolith is a console application which requires very specific
project setup and arguments, `go run .\main.go` doesn't really do anything.

Expand All @@ -59,17 +53,16 @@ of useful test commands:
- `dlv test ./test -- "-test.run" TestInstallAllAndRun` - debug the "TestInstallAllAndRun"
test using [delve](https://github.com/go-delve/delve)

## 🏗 Building as a `.exe`:
You can also use [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=golang.Go) to run tests.

## 🏗 Building as a `.exe`:
- You can build either with *GoReleaser*, or natively

### 1. Install GoReleaser
### 1. Native
There are a few ways to build:
- `go install` (installs to gopath)
- `go build` (creates a `.exe` file)

### 2. GoReleaser
- `go install github.com/goreleaser/goreleaser@latest`

### 2. Build

There are a few ways to build:
- `go install` (installs to gopath)
- `go build` (creates a `.exe` file)
- `./scripts/build-local.sh` (¯\_(ツ)_/¯)
- `./scripts/build-local.sh` - use this script to build the project with GoReleaser.
167 changes: 0 additions & 167 deletions docs/docs/.vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,173 +42,6 @@ export default defineConfig({
footer: {
message: 'Released under the MIT license.',
copyright: `Copyright © ${new Date().getFullYear()} Bedrock OSS.`
},

nav: [
{
text: 'Guide',
link: '/guide/what-is-regolith',
activeMatch: '/guide/'
},
{
text: 'Standard Library',
link: '/standard-library'
},
{
text: 'Community Filters',
link: '/community-filters'
},
{
text: 'Resources',
items: [
{
text: 'Project Config Standard',
link: 'https://github.com/Bedrock-OSS/project-config-standard'
}
]
},
{
text: await getLatestVersion(),
items: [
{
text: 'Release Notes',
link: 'https://github.com/Bedrock-OSS/regolith/releases'
}
]
}
],

sidebar: {
'/guide/': [
{
text: 'Introduction',
collapsible: true,
items: [
{
text: 'What Is Regolith?',
link: '/guide/what-is-regolith'
},
{
text: 'Installing',
link: '/guide/installing'
},
{
text: 'Getting Started',
link: '/guide/getting-started'
},
{
text: 'Troubleshooting',
link: '/guide/troubleshooting'
}
]
},
{
text: 'Advanced',
collapsible: true,
items: [
{
text: 'Configuration File',
link: '/guide/configuration'
},
{
text: 'User Configuration',
link: '/guide/user-configuration'
},
{
text: 'Data Folder',
link: '/guide/data-folder'
},
{
text: 'Export Targets',
link: '/guide/export-targets'
},
{
text: 'Profiles',
link: '/guide/profiles'
},
{
text: 'Experiments',
link: '/guide/experiments'
},
{
text: 'Safety',
link: '/guide/safety'
}
]
},
{
text: 'Filters',
collapsible: true,
items: [
{
text: 'Introduction',
link: '/guide/filters'
},
{
text: 'Local Filters',
link: '/guide/local-filters'
},
{
text: 'Custom Filters',
link: '/guide/custom-filters'
},
{
text: 'Online Filters',
link: '/guide/online-filters'
},
{
text: 'Installing Filters',
link: '/guide/installing-filters'
},
{
text: 'Filter Run Modes',
link: '/guide/filter-run-modes'
},
{
text: 'Create a Filter',
link: '/guide/create-a-filter'
}
]
},
{
text: 'Filter Types',
collapsible: true,
items: [
{
text: 'Java Filters',
link: '/guide/java-filters'
},
{
text: '.NET Filters',
link: '/guide/dotnet-filters'
},
{
text: 'Nim Filters',
link: '/guide/nim-filters'
},
{
text: 'Python Filters',
link: '/guide/python-filters'
},
{
text: 'Shell Filters',
link: '/guide/shell-filters'
},
{
text: 'NodeJS Filters',
link: '/guide/node-filters'
},
{
text: 'Deno Filters',
link: '/guide/deno-filters'
},
{
text: 'Profile Filters',
link: '/guide/profile-filters'
}
]
}
]
}
}
})
68 changes: 0 additions & 68 deletions docs/docs/community-filters.md
View file
Open in desktop

This file was deleted.

Loading