Skip to main content

nx-start

Project generator for Nintendo Switch homebrews.

https://travis-ci.org/roedesh/nxstart.svg?branch=master

Features

  • Generate a libnx (C++) project using nxstart libnx

  • Generate a libtransistor (C) project using nxstart libt

  • Generate a BrewJS (Javascript) project using nxstart brewjs

  • Generate a PyNX (Python) project using nxstart pynx

Installation

Install from PyPi using pip, a package manager for Python.

$ pip install nxstart

Don’t have pip installed? Try installing it, by running this from the command line:

$ curl https://bootstrap.pypa.io/get-pip.py | python

Or, you can download the source code for nxstart and then run:

$ python setup.py install

You may need to run the above commands with sudo.

Generating a libnx (C++) project

Run nxstart libnx. It will ask for a project name, author name and if you are using CLion (IDE by Jetbrains). If you say yes to CLion, CMakeLists.txt will be included.

The following project structure will be generated:

project
│   .editorconfig
│   .gitignore
│   CMakeLists.txt  // Only if you use CLion
│   Makefile
│   icon.jpg
│   README.md
│
└───data
│
└───include
│
└───source
    │   main.cpp    // Your main application file

Generating a libtransistor (C) project

Run nxstart libt. It will ask for a project name, author name and if you are using CLion (IDE by Jetbrains). If you say yes to CLion, CMakeLists.txt will be included.

The following project structure will be generated:

project
│   .editorconfig
│   .gitignore
│   CMakeLists.txt  // Only if you use CLion
│   main.c
│   Makefile
│   icon.jpg
│   README.md
│

Generating a BrewJS (Javascript) project

Run nxstart brewjs. It will ask for a project name, author name. The following project structure will be generated:

project
│   .editorconfig
│   .gitignore
│   package.json
│   Source.js        // Your main application file
│   README.md
│
└───assets
│

Generating a PyNX (Python) project

Run nxstart pynx. It will ask for a project name, author name. The following project structure will be generated:

project
│   .editorconfig
│   .gitignore
│   main.py        // Your main application file
│   README.md
│

Skip prompts

To skip the prompts, provide the necessary flags. For example:

$ nxstart -n "My new project" -a "John Doe" libnx --clion

Or if you don’t use CLion:

$ nxstart -n "My new project" -a "John Doe" libnx --no-clion

Running tests

Tests can be run with the pytest command. If you are contributing code, make sure all tests are green before submitting a PR.

Metadata

Release files for nxstart 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nxstart 1.1.0
File Size Uploaded Provenance Actions
nxstart-1.1.0.tar.gz 48.3 kB Without provenance Details for nxstart-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for nxstart 1.1.0
File Interpreter ABI Platform Actions
nxstart-1.1.0-py3-none-any.whl Python 3 none any Details for nxstart-1.1.0-py3-none-any.whl

Total release size: 132.7 kB

Release files / nxstart-1.1.0.tar.gz

Download URL nxstart-1.1.0.tar.gz
Size 48.3 kB
Tags Source
SHA-256 checksum
How to use checksums
24a1791ca7817f9d3db470a796e25bbaac6292199e711f853af2aa1841c3bb8e
BLAKE2b-256 checksum
How to use checksums
6db213bb2a47696f127f5d83fc78e2b453974f27dd6b36a07bfaf127877008b7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / nxstart-1.1.0-py3-none-any.whl

Download URL nxstart-1.1.0-py3-none-any.whl
Size 84.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4850157d66b4c8c1186d63120f183a4827f45c7f0be71ee17b5e4bd484785efd
BLAKE2b-256 checksum
How to use checksums
c0f234c53eff15778171981ab5189bcde6698451a15e68bc36b4ae20d4700482
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for nxstart 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page