enigma-bbs/docs/installation/windows.md

2.4 KiB

layout title
page Installation Under Windows

Installation Under Windows

ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit doors natively then you should use a 32bit Windows.

Basic Instructions

  1. Download and Install Node.JS.

    1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. *Run PowerShell as Administrator

      *Initial Install

      Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force
      npm install -g npm-windows-upgrade
      

      *Upgrade

      npm-windows-upgrade
      

      Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. Also if you run the NodeJS installer, it will replace the node version.

    2. Install windows-build-tools for npm *This will also install python 2.7

      npm install --global --production windows-build-tools
      
  2. Install 7zip.

    *Add 7zip to your path so 7z can be called from the console

    1. Right click This PC and Select Properties
    2. Go to the Advanced Tab and click on Environment Variables
    3. Select Path under System Variables and click Edit
    4. Click New and paste the path to 7zip
    5. Close your console window and reopen. You can type 7z to make sure it's working.

(Please see Archivers for additional archive utilities!)

  1. Install Git and optionally TortoiseGit.

  2. Clone ENiGMA½ - browse to the directory you want and run

    git clone "https://github.com/NuSkooler/enigma-bbs.git"
    

    Optionally use the TortoiseGit by right clicking the directory and selecting Git Clone.

  3. Install ENiGMA½.

    1. In the enigma directory run
    npm install
    
    1. Generate your initial configuration: Follow the prompts!
    	node .\oputil.js config new
    
    1. Edit your configuration files in enigma-bbs\config with Notepad++ or Visual Studio Code
    2. Run ENiGMA½
    	node .\main.js
    
  4. Look at Production Installation for maintaining ENiGMA½ when you are ready to go live.