better-fabric-console

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

better-fabric-console

★ 71 Open GitHub ↗

Server-side Fabric mod enhancing the console with tab completions, colored log output, command syntax highlighting, command history, and more.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Better Fabric Console

Better Fabric Console is a server-side Fabric mod that replaces the vanilla dedicated server console experience with an interactive, color-aware terminal.

## Features

- Brigadier-aware command completion in the server console
- Command syntax highlighting with configurable argument colors
- Colored log output in terminal consoles
- Persistent command history in `.console_history`
- Optional logging of player-executed commands

![Screenshot 1](https://raw.githubusercontent.com/jpenilla/better-fabric-console/master/docs/images/screenshot_1.png)

## Requirements

- Fabric server
- [Fabric API](https://modrinth.com/mod/fabric-api)
- [adventure-platform-fabric](https://modrinth.com/mod/adventure-platform-mod)

## Installation

1. Download the latest Better Fabric Console, Fabric API, and adventure-platform-fabric jars.
2. Place the jars in your server `mods/` directory.
3. Start the server once to generate config files.
4. Stop the server and edit configuration as needed.
5. Start the server again.

You may also choose to run the server with the `--nogui` argument (i.e. `java -jar fabric.jar --nogui`)
to disable the server GUI (this is a Vanilla option).

## Configuration

Better Fabric Console generates and reads:

- `config/better-fabric-console/better-fabric-console.conf`
- `config/better-fabric-console/log4j2.xml`

The bundled default Log4j config is also written to `config/better-fabric-console/defaults/log4j2.xml` for reference.
If you customize `log4j2.xml` and the bundled default changes, Better Fabric Console will warn on startup until you review/merge the change and run:

```text
/better-fabric-console dismiss-log4j-config-update
```

You can also start once with `-Dbetter-fabric-console.dismiss-log4j-config-update=true` to dismiss the warning.

Default `better-fabric-console.conf` for reference:

```hocon
# Specify argument highlight colors, in order. Possible values: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE]
highlight-colors=[
    CYAN,
    YELLOW,
    GREEN,
    MAGENTA,
    BLUE
]
# Whether to log commands executed by players to console.
log-player-executed-commands=true
```

[Click here](src/main/resources/better-fabric-console-default-log4j2.xml) to see the default `log4j2.xml` configuration.

Better Fabric Console also respects the following system properties to override terminal environment detection:
- Adventure ANSI properties: https://docs.papermc.io/adventure/serializer/ansi/

Changes require a server restart.

## Command

- `/better-fabric-console` (operator-level): Prints mod version information.
- `/better-fabric-console dismiss-log4j-config-update` (operator-level): Marks the current bundled Log4j default as reviewed.

## License

MIT. See `license.txt`.

better-fabric-console

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README