Skip to content
/ Foundry Public

A powerful CLI tool for bootstrapping Minecraft plugins with modern development tooling.

License

Notifications You must be signed in to change notification settings

abb3v/Foundry

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Foundry CLI

A powerful CLI tool for bootstrapping Minecraft plugins with modern development tooling.

License: MIT Version PRs Welcome

🚀 Features

  • Interactive Setup: User-friendly CLI interface for creating new plugin projects
  • Multiple Build Systems: Support for Maven and Gradle
  • Smart Defaults: Intelligent project structure and naming conventions
  • Modern Tooling: Built with TypeScript for reliability and maintainability

📦 Installation

# Using npm
npm install -g foundry-cli

# Using yarn
yarn global add foundry-cli

🎮 Usage

To create a new plugin project, simply run:

foundry

Command Line Options

Options:
  -V, --version        Output the version number
  -y, --yes            Skip confirmation prompts
  -i, --inline         Run in inline mode (no alternate screen)
  --no-color           Disable colors in output
  -v, --verbose        Show detailed error messages
  -h, --help           Display help message

Examples

# Start interactive setup
foundry

# Skip all confirmations
foundry --yes

# Run in inline mode
foundry --inline

# Inline mode with no confirmations
foundry -i -y

🔧 Environment Variables

You can customize default behaviors using environment variables:

  • FOUNDRY_DEFAULT_AUTHOR: Set default author name
  • FOUNDRY_DEFAULT_PACKAGE: Set default package prefix

🤝 Contributing

Contributions are welcome! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🛠️ Development

# Clone the repository
git clone https://github.com/abb3v/foundry.git

# Install dependencies
npm install

# Build the project
npm run build

# Link for local development
npm link

# Run in development mode
npm run dev

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments


Made with ❤️ by Abb3v & Kalani

About

A powerful CLI tool for bootstrapping Minecraft plugins with modern development tooling.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published