Code Monkey home page Code Monkey logo

lovecraft's Introduction


LöveCraft

A simple CLI tool to package games made with LÖVE on Windows.

Features

  • Package games with just one command
  • Easily add icon to the executable
  • Each project can have it's own LöveCraft config file
  • Great tool for consistent packaging

Requirements

  • LÖVE framework available in PATH
  • ResourceHacker available in PATH
  • Optional craft.ini file with the preferred configurations avaiable in the root of the project directory.
  • Optional .exclude file in the root of the project directory with files and folders in relative paths to avoid archiving before packaging the game.

NOTE: Look inside the example folder for a sample game project

Installation

  1. Download the binary.
  2. Add the path to the binary location to the PATH environment variable.

Usage

Usage: lovecraft.exe [OPTIONS] [SRC]

  Packages LÖVE game for distribution.

  SRC - Path to project directory

Options:
  -n, --name TEXT  Name for the game
  -i, --icon PATH  Path to '.ico' file
  --crafts-dir     Show the packaging location and exit.
  --version        Show the version and exit.
  --help           Show this message and exit.
  • The packaged game is created in the %USERPROFILE%\crafts directory.
  • The --name and --icon are optional and there are fallback values for them if not provided.
  • Running lovecraft with no path provided also works when you're in the project directory or by providing . as an argument.

Config

  • You can create a config for the name and icon in the project's root if you're packaging the game consistently.
  • If --name or --icon is provided, the config file is not considered.
; Sample craft.ini file
[Game]
name = MyAwesomeGame
icon = assets\icon\icon.ico

lovecraft's People

Contributors

miltontom avatar

Stargazers

 avatar The Finch Company avatar

Watchers

 avatar pug avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.