### Example Project Structure
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/tips/interface-injection
Illustrates the expected directory structure for a Stonecutter project using Fabric interface injection. Shows where the shared fabric.mod.json resides.
```plaintext
.
├── src/main/resources/
│ └── fabric.mod.json
├── versions/
│ └── 1.21/
│ └── src/main/resources/
│ └── (fabric.mod.json expected here)
├── build.gradle[.kts]
├── stonecutter.gradle[.kts]
└── settings.gradle[.kts]
```
--------------------------------
### JSON5 Project Specification Examples
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/config/projects_display=source
Demonstrates various ways to define project structures and versions in JSON5 format for Stonecutter. This includes composite and primitive project declarations, and configurations for single branch, branch-first, and version-first project setups. These examples are crucial for integrating dynamic data into Stonecutter's project management.
```json5
```json5 [versions.json5]
{
project: "snapshot",
// Optional, defaulting to `project`.
version: "1.21.9-snapshot",
// Optional, defaulting to `centralScript` in `settings.gradle[.kts]`.
buildscript: "snapshot.gradle.kts"
}
```
```
```json5
```json5 [versions.json5]
// Same fields as in the composite type, but separated with `:`.
// To specify the build script without an explicit version, use the `::` separator.
"snapshot:1.21.9-snapshot:snapshot.gradle.kts"
```
```
```json5
```json5 [versions.json5]
{
"$schema": "https://codeberg.org/stonecutter/stonecutter/src/branch/0.7/tools/settings-schema.json",
versions: [
"1.20.1", "1.21.1", "1.21.8",
{
project: "snapshot",
version: "1.21.9-snapshot"
}
]
}
```
```
```json5
```json5 [versions.json5]
{
"$schema": "https://codeberg.org/stonecutter/stonecutter/src/branch/0.7/tools/settings-schema.json",
branches: {
"": [
"1.20.1", "1.21.1", "1.21.8",
{
project: "snapshot",
version: "1.21.9-snapshot"
}
],
"subproject": {
// Metadata for third-party tools
custom: "...",
versions: [
"1.20.1", "1.21.1", "1.21.8"
]
}
}
}
```
```
```json5
```json5 [versions.json5]
{
"$schema": "https://codeberg.org/stonecutter/stonecutter/src/branch/0.7/tools/settings-schema.json",
versions: {
// `""` corresponds to the root branch in the directory of the `stonecutter.gradle[.kts]` file.
"1.20.1": ["", "subproject"],
"1.21.1": ["", "subproject"],
"1.21.8": ["", "subproject"],
"snapshot:1.21.9-snapshot": {
// Metadata for third-party tools
custom: "...",
branches: [""]
},
}
}
```
```
--------------------------------
### JSON Project Specification (Composite)
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/config/projects
Example of a composite project specification in JSON format used with Stonecutter. Includes project name, version, and buildscript fields. This specifies project details in JSON format for Stonecutter configuration.
```json
{
project: "snapshot",
// Optional, defaulting to `project`.
version: "1.21.9-snapshot",
// Optional, defaulting to `centralScript` in `settings.gradle[.kts]`.
buildscript: "snapshot.gradle.kts"
}
```
--------------------------------
### JSON Dependency Injection Example
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/tips/resource-processing_display=source
An example of a `fabric.mod.json` file showing how dependencies are structured, with comments indicating where new dependencies can be injected.
```json
{
// other properties
"requires": {
"fabric": ">=0.16",
"minecraft": "${minecraft}",
// inject dependencies here
}
}
```
--------------------------------
### Kotlin: Code Structure Example
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/config/params_display=source
A basic example of code structure in Kotlin, illustrating nested scopes similar to `if-else` blocks. This provides context for Stonecutter's scope organization.
```kotlin
if (condition1) {
// Scope of the `condition1` branch
action1()
action2()
} else
// Scope of the `else` branch
action3()
```
--------------------------------
### JavaScript: Initialize Kotlin Playground
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.replacement/-replacement-executor/index
This script asynchronously loads the Kotlin Playground library from a CDN. It's essential for enabling interactive Kotlin code examples within the documentation.
```javascript
const storage = localStorage.getItem("dokka-dark-mode")
```
--------------------------------
### HTML Structure for Stonecutter Website
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.process/-s-c-external-switch-task/version
The HTML structure defines the document type, head section with meta tags, scripts, and stylesheets, and the body with navigation and container elements.
```html
version
```
--------------------------------
### JavaScript for Script Loading and Initialization
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.data/-project-hierarchy/or-blank
This section details the various JavaScript files loaded asynchronously or deferred to enable website functionality. It includes scripts for Kotlin playground, source set dependencies, styling, navigation, platform content handling, and UI kit elements.
```javascript
```
--------------------------------
### Invalid fabric.mod.json Placeholder Example
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/tips/interface-injection
Shows an example of unsupported placeholder usage in fabric.mod.json that conflicts with Loom's override feature. The unprocessed JSON must be valid.
```json
{
"schemaVersion": 1,
"id": "${id}",
"version": "${version}",
// ... | this is unsupported
${injected_entry}
}
```
--------------------------------
### Basic HTML Structure Setup
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.process/-s-c-idea-config-task/run
Core HTML5 document structure with viewport settings, title definition, and linking to essential stylesheets and scripts. Includes resource links for favicon, CSS, and JavaScript dependencies required for Dokka documentation rendering.
```html
run
```
--------------------------------
### Initialize HTML Document Structure with Meta Configuration
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.data.tree.struct/-project-tree/nodes
Sets up the basic HTML document structure for the documentation interface with viewport settings, character encoding, and title configuration. Includes initial CSS class management and script loading for theme functionality.
```html
nodes
```
--------------------------------
### HTML Structure and Script Includes
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.process/-s-c-prepare-task/destination
This HTML snippet defines the basic structure of the web page, including the viewport settings, title, and icon. It also includes essential JavaScript and CSS files for styling, navigation, search functionality, and interactivity. The script `kotlin-playground@1` is included for code examples, and `sourceset_dependencies.js` is likely for managing build dependencies.
```html
destination
```
--------------------------------
### Token Property Declarations in Kotlin
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.block/-comment-block/index
Declares three read-only properties (val) of type Token: content, end, and start. These properties are used to store tokenized content markers in the Stonecutter project.
```kotlin
val content: Token
```
```kotlin
val end: Token
```
```kotlin
val start: Token
```
--------------------------------
### Class Constructor with Token Parameters in Kotlin
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.block/-comment-block/index
Defines a constructor that takes three Token parameters: start, content, and end. This is likely used for initializing objects that handle tokenized content in the Stonecutter project.
```kotlin
constructor(start: Token, content: Token, end: Token)
```
--------------------------------
### Stonecutter Settings Extension: Create Project Settings
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/scripts/pages
This group of endpoints allows the creation of project settings. You can create settings for a single project or multiple projects, with options to specify a file and a custom action to be performed during creation. The `create` function has several overloads to accommodate different input types for projects (single `ProjectReference` or an iterable/vararg of `ProjectReference`) and the inclusion of a `File` object.
```APIDOC
## POST /api/stonecutter/settings/create
### Description
Creates settings for a single project.
### Method
POST
### Endpoint
/api/stonecutter/settings/create
### Parameters
#### Request Body
- **project** (ProjectReference) - Required - The project for which to create settings.
- **file** (File) - Optional - A file associated with the settings.
- **action** (Action) - Optional - A custom action to perform during creation. Defaults to a shared action.
### Request Example
```json
{
"project": {"groupId": "com.example", "artifactId": "my-project"},
"file": "path/to/settings.gradle",
"action": { /* TreeBuilder action details */ }
}
```
### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
#### Response Example
```json
{
"status": "Settings created successfully"
}
```
---
## POST /api/stonecutter/settings/create/batch
### Description
Creates settings for multiple projects.
### Method
POST
### Endpoint
/api/stonecutter/settings/create/batch
### Parameters
#### Request Body
- **projects** (Array) - Required - An iterable or vararg of projects for which to create settings.
- **file** (File) - Optional - A file associated with the settings.
- **action** (Action) - Optional - A custom action to perform during creation. Defaults to a shared action.
### Request Example
```json
{
"projects": [
{"groupId": "com.example", "artifactId": "project-a"},
{"groupId": "com.example", "artifactId": "project-b"}
],
"file": "path/to/settings.gradle",
"action": { /* TreeBuilder action details */ }
}
```
### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
#### Response Example
```json
{
"status": "Batch settings created successfully"
}
```
```
--------------------------------
### Configure project versioning with file in Kotlin
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.settings/-stonecutter-settings-extension/create
The create function configures multiple projects to be versioned using a specified file. It takes an iterable of ProjectReference, a File, and an optional Action. No specific dependencies beyond Gradle and Stonecutter, inputs are projects and file, output is configuration via action. Limitations include requirement for valid file path.
```kotlin
@JvmOverloads
fun create(projects: Iterable, file: File, action: Action = shared)
```
--------------------------------
### CommentBlock Data Class Definition (Kotlin)
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.block/-comment-block/index
Defines the CommentBlock data class, which represents a regular comment block in the Stitcher Processor. It is marked with @Serializable and contains start, content, and end tokens of type Token. This class inherits from the Block interface.
```kotlin
import kotlinx.serialization.Serializable
import dev.kikugie.stitcher.data.token.Token
import dev.kikugie.stitcher.data.block.Block
@Serializable
data class CommentBlock(
val start: Token,
val content: Token,
val end: Token
) : Block
```
--------------------------------
### HTML document structure with theme detection
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.build.param/-stonecutter-build-data/dependencies-property
Sets up the basic HTML structure with meta tags and implements dark/light theme detection based on OS preferences or localStorage settings. Includes viewport settings and character encoding.
```html
dependenciesProperty
```
--------------------------------
### Registering Access Widener Converters in Stonecutter (Groovy DSL)
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/fletching-table/accessconverters
Shows how to register Access Widener converters within the Stonecutter build script using the Groovy DSL. It includes examples for specifying the source file and optionally the destination path for the converted Access Transformer.
```groovy
fletchingTable {
accessConverter.register(sourceSets.main) {
// Access widener file relative to `src/main/resources`
// Converted to `META-INF/accesstransformer.cfg` by default
add("example.accesswidener")
// Optional destination parameter and extra converters
add("extra.accesswidener", "META-INF/extra-accesstransformer.cfg")
}
}
```
```groovy
fletchingTable {
accessConverter.register("main") {
// Access widener file relative to `src/main/resources`
// Converted to `META-INF/accesstransformer.cfg` by default
add("example.accesswidener")
// Optional destination parameter and extra converters
add("extra.accesswidener", "META-INF/extra-accesstransformer.cfg")
}
}
```
--------------------------------
### HTML Head Setup for Documentation Page
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.controller/-stonecutter-controller-manager/filename
Defines the document head with meta tags, title, favicon, and script inclusions for path setting, JS class replacement, and deferred loading of documentation utilities. Includes links to CSS stylesheets for layout, themes, and UI components. Purpose is to prepare the page for interactive Kotlin docs; depends on external files like style.css and scripts; outputs a styled, script-ready page; limitations include reliance on relative paths and async loading.
```html
filename
```
--------------------------------
### Define multi-project directory layouts
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/config/branches
Shows standard multi-project directory structures for Stonecutter projects. The first example demonstrates separate api/versions and versions/ directories, while the second shows a multi-loader setup with fabric/, forge/, and neoforge/ subprojects. These layouts enable branch-based version management across different modules.
```text
.
├── api/
│ ├── versions/
│ │ ├── 1.20.1
│ │ └── 1.21.1
│ └── build.gradle[.kts]
├── versions/
│ ├── 1.20.1
│ └── 1.21.1
└── build.gradle[.kts]
or
.
├── fabric/
│ ├── versions/
│ │ ├── 1.20.1
│ │ └── 1.21.1
│ └── build.gradle[.kts]
├── forge/
│ ├── versions/
│ │ └── 1.20.1
│ └── build.gradle[.kts]
├── neoforge/
│ ├── versions/
│ │ └── 1.21.1
│ └── build.gradle[.kts]
├── versions/
│ ├── 1.20.1
│ └── 1.21.1
└── build.gradle[.kts]
```
--------------------------------
### HTML Document Structure and Meta Information
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.process/-s-c-prepare-task/index
This snippet shows the basic HTML document structure, including doctype, html tag with no-js class, head section with viewport meta tag, title, icon, and script tags for initializing dark mode. It sets up the initial state of the page for different browsers and user preferences.
```html
SCPrepareTask
```
--------------------------------
### Declare start token property in Kotlin
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.block/-code-block/index
Represents the 'start' property as a Token object in Kotlin, serving as the comment start marker. Integral to token-based parsing in Stitcher; no specific inputs required. Provides read-only access to the start token for comment handling.
```kotlin
val start: Token
```
--------------------------------
### HTML Structure and Initialization
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.build.param/-stonecutter-build-properties/dependencies
This snippet shows the basic HTML document structure, including meta tags for viewport and character set, title, icon, and initial JavaScript for enabling dark mode based on user preferences or OS settings. It also includes script tags for various JavaScript files that handle UI functionalities, navigation, and code highlighting.
```html
dependencies
```
--------------------------------
### GET /projectBranch/get
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.data.tree.struct/-project-branch/get
Retrieves a ProjectNode associated with a specified ProjectHierarchy node. This method is abstract and can be by implementations.
```APIDOC
## GET /projectBranch/get
### Description
Retrieves a ProjectNode associated with the given ProjectHierarchy node.
### Method
GET
### Endpoint
/projectBranch/get
### Parameters
#### Path Parameters
- **node** (ProjectHierarchy) - Required - The project hierarchy node for which to retrieve the associated ProjectNode.
#### Query Parameters
*(none)*
#### Request Body
*(none)*
### Request Example
```
{
"node": ""
}
```
### Response
#### Success Response (200)
- **projectNode** (ProjectNode) - The retrieved project node, or null if not found.
#### Response Example
```
{
"projectNode": {
"id": "example-id",
"name": "example-name"
}
}
```
```
--------------------------------
### HTML Structure for Documentation Page
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.build.param/-stonecutter-build-config/versions
Defines the basic HTML structure of the documentation page. Includes viewport settings, title, and references to stylesheets and scripts required for rendering the page.
```html
versions
```
--------------------------------
### GET /regexreplacement/phase
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.replacement/-regex-replacement/index
Gets the execution phase for the replacement, indicating whether it occurs before or after parsing.
```APIDOC
## GET /regexreplacement/phase
### Description
Gets the execution phase for the replacement, indicating whether it occurs before or after parsing.
### Method
GET
### Endpoint
/regexreplacement/phase
### Response
#### Success Response (200)
- **phase** (ReplacementPhase) - The execution phase of the replacement
#### Response Example
{
"phase": "before_parsing"
}
```
--------------------------------
### Language File Example - TOML
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/fletching-table/languages
Example of language file written in TOML format.
```toml
[modid.item]
foo = "Foo Item"
bar = "Bar Item"
[modid.block]
foo = "Foo Block"
bar = "Bar Block"
```
--------------------------------
### Initialize Documentation Root Path and Enable JavaScript
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter/-stonecutter-plugin/-companion/-v-e-r-s-i-o-n
Sets global pathToRoot variable to enable correct resource loading across documentation pages. Replaces no-js class with js to indicate JavaScript availability for conditional styling and progressive enhancement.
```javascript
var pathToRoot = "../../../../";
document.documentElement.classList.replace("no-js","js");
```
--------------------------------
### HTML Document Structure with Meta Tags
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stonecutter/dev.kikugie.stonecutter.build.param/-stonecutter-build-data/-stonecutter-build-data
Basic HTML5 document structure with meta tags for viewport settings, character encoding, and title. Includes links to stylesheets and scripts.
```HTML
StonecutterBuildData
```
--------------------------------
### Language File Example - JSON5
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/fletching-table/languages
Example of language file written in JSON5 format.
```json5
modid:
item:
foo: "Foo Item"
bar: "Bar Item"
block:
foo: "Foo Block"
bar: "Bar Block"
```
--------------------------------
### Stonecutter Project Creation (Kotlin)
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/wiki/config/projects
Demonstrates how to create a Stonecutter project using a JSON file in Kotlin. It utilizes the `create` function within the Stonecutter DSL, referencing version settings from a JSON file. Dependencies on Stonecutter Gradle plugin are required.
```Kotlin
stonecutter {
create(rootProject, file("versions.json"))
}
```
```Kotlin
stonecutter {
create(getRootProject(), file("versions.json"))
}
```
--------------------------------
### HTML Structure for Documentation Page
Source: https://codeberg.org/stonecutter/docs/src/branch/main/docs/public/dokka/stitcher/dev.kikugie.stitcher.data.scope/-scope-type/-w-o-r-d/index
This HTML defines the basic page layout for the Stonecutter KDoc site, including head with meta tags, scripts for functionality, and body starting with navigation elements. It depends on external CSS and JS files for styling and behavior. Inputs are none; outputs a rendered documentation interface. Limitations: Static structure requiring JS for interactivity; placeholder title 'WORD' suggests incomplete setup.
```html
WORD