Skip to content

Latest commit

 

History

History
176 lines (128 loc) · 6.62 KB

README.md

File metadata and controls

176 lines (128 loc) · 6.62 KB
Raw

GitHub top language Issues License Commit activity Last commit PyPI Downloads PyPI Total Downloads PyPI Version

nxtheme-creator

Project Icon

Generate custom themes for your Nintendo Switch from your images, with optional configuration for layout adjustments. Specify the path to the nxtheme executable and provide the directory for your input images, output files, and an optional configuration file.

Usage:

usage: nxtheme-creator [-h] [--nxtheme NXTHEME] [--input INPUT] [--output OUTPUT] [--config CONFIG]

Options:

  • -h, --help: Show help message and exit.
  • --nxtheme NXTHEME: The path to the nxtheme executable (e.g., /path/to/SwitchThemes.exe). This can be obtained from SwitchThemeInjector.
  • --input INPUT: Specify the directory containing your input images.
  • --output OUTPUT: Define the directory where the generated theme files will be saved.
  • --config CONFIG: Provide an optional configuration file (conf.json) to customize layout settings.

Documentation

A high-level overview of how the documentation is organized organized will help you know where to look for certain things:

  • Tutorials take you by the hand through a series of steps to get started using the software. Start here if you’re new.
  • The Technical Reference documents APIs and other aspects of the machinery. This documentation describes how to use the classes and functions at a lower level and assume that you have a good high-level understanding of the software.

Install With PIP

pip install nxtheme-creator

Head to https://pypi.org/project/nxtheme-creator/ for more info

Language information

Built for

This program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and 3.11

Building

This project uses https://github.com/FHPythonUtils/FHMake to automate most of the building. This command generates the documentation, updates the requirements.txt and builds the library artefacts

Note the functionality provided by fhmake can be approximated by the following

handsdown  --cleanup -o documentation/reference
poetry export -f requirements.txt --output requirements.txt
poetry export -f requirements.txt --with dev --output requirements_optional.txt
poetry build

fhmake audit can be run to perform additional checks

Download Project

Clone

Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2 
    git clone https://github.com/FHPythonUtils/nxtheme-creator

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community Files

Licence

GPL-2.0 License (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

Online communities include people from many backgrounds. The Project contributors are committed to providing a friendly, safe and welcoming environment for all. Please see the Code of Conduct for more information.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Support

Thank you for using this project, I hope it is of use to you. Please be aware that those involved with the project often do so for fun along with other commitments (such as work, family, etc). Please see the Support Policy for more information.

Rationale

The rationale acts as a guide to various processes regarding projects such as the versioning scheme and the programming styles used. Please see the Rationale for more information.