Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 3.94 KB

README.md

File metadata and controls

107 lines (72 loc) · 3.94 KB
Raw

NecroEdit

External level editor for Crypt of the NecroDancer.

Download the latest release here!

Please see the section Installation if you are having issues running NecroEdit.

Features

  • Mouse controls
  • Graphical tile and object selection
  • Level arrangement and duplication
  • Better object placement
    • Multiple objects can be stacked on the same tile
  • Movable player spawn point
  • Additional tiles and objects
    • Tiles and objects that are normally inaccessible in the editor can be placed
    • Examples: Lava tiles, Golden Lute, Ninja Mask
  • Additional settings for objects
    • Examples: Lord enemies, single choice items, hidden chests

Controls

Choose a tool from the toolbar at the top of the editor window to get started.

  • Left click to place objects or tiles.
  • Right click to erase objects or tiles.
  • Middle click to move the view around the level.
  • Use the mouse wheel to zoom in or out.

Installation

NecroEdit requires a copy of Crypt of the NecroDancer to be installed on your computer.

Windows

Download the latest release here!

Extract the Windows release archive to your desired installation folder and open NecroEdit.exe.

If any errors messages show up when you start NecroEdit, please report the bug by opening an issue on NecroEdit's issue tracker on GitHub.

Linux

Download the latest release here!

SFML 2.3 is required. You can install it using your distribution's package manager or from the library's website.

Additionally, a recent version (GLIBCXX >= 3.4.18) of the GNU C++ runtime library (libstdc++6) is required.

Extract the Linux release archive to your desired installation path and run ./NecroEdit in the installation path.

Only 64-bit Linux binaries are provided. To use NecroEdit on 32-bit Linux, a build from source is required.

Building from source

Clone this repository using Git and use CMake to build NecroEdit from source.

git clone https://github.com/Marukyu/NecroEdit.git
cd NecroEdit
cmake .
make

Library and header files for SFML 2.3 (and its dependencies) must be installed.

A C++11 compliant compiler such as GCC 4.8 or Visual Studio 2015 is required to build NecroEdit.

Screenshots

Editing level (zoomed in)
Editing level (zoomed out)
Item placement

(Game content in screenshots from Crypt of the NecroDancer; Copyright Brace Yourself Games)

Contributors

License (MIT License)

Copyright (c) 2016 Marukyu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.