Skip to main content

Project generator for Nintendo Switch homebrews. A work in progress.

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.

Creating 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 created:

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

└───data

└───include

└───source
       main.cpp    // Your main application file

Creating 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 created:

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

Creating a BrewJS (Javascript) project

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

project
   .editorconfig
   .gitignore
   HOW-TO-RUN.txt  // Explains how to run a BrewJS app on the Switch.
   index.js        // Your main application file
   README.md

└───assets

Creating a PyNX (Python) project

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

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" cpp --clion

Or if you don’t use CLion:

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nxstart-0.4.0.tar.gz (46.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nxstart-0.4.0-py3-none-any.whl (79.1 kB view details)

Uploaded Python 3

File details

Details for the file nxstart-0.4.0.tar.gz.

File metadata

  • Download URL: nxstart-0.4.0.tar.gz
  • Upload date:
  • Size: 46.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nxstart-0.4.0.tar.gz
Algorithm Hash digest
SHA256 6b9fb3ae5184ba8d2c0ff4bae4dc3c706c36edd38a577b6037d6a85006f5985f
MD5 24c94a0a05082c02a16d0180b2120ed0
BLAKE2b-256 4b924234c80638241563ad1facd9dfacf481f7cafa7465c65571d2c81ab1062f

See more details on using hashes here.

File details

Details for the file nxstart-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nxstart-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f9f68666817a415198bb3c9358079b7ad4783becdcf160812dd25f0978189bea
MD5 0cd85334d6ce280a951661553753a2b2
BLAKE2b-256 f08bbd6034171bf51fe49ed2710eae9553dcda4e26aab7d9130c0b95dc3ea574

See more details on using hashes here.

Release history Release notifications | RSS feed

1.1.3

2 files

1.1.2

2 files

1.1.0

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.5.0

2 files

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

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