https://github.com/azerothcore/noggit

Map creator
https://github.com/azerothcore/noggit

Last synced: about 1 year ago
JSON representation

Map creator

• Host: GitHub
• URL: https://github.com/azerothcore/noggit
• Owner: azerothcore
• License: gpl-3.0
• Created: 2017-08-19T08:57:18.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2017-08-19T09:11:54.000Z (almost 9 years ago)
• Last Synced: 2025-04-28T02:33:58.217Z (about 1 year ago)
• Language: C++
• Size: 1.16 MB
• Stars: 7
• Watchers: 4
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

          
# LICENSE #

This software is open source software licensed under GPL3, as found in

the COPYING file.

# CONTRIBUTORS #

A  list  of  known  contributors  can be  found  in  the  CONTRIBUTORS

file.  New maintainers  should  list  themselves there  as  it is  not

automatically updated.

# BUILDING #

This  project  requires  CMake  to  be built.  It  also  requires  the

following libraries:

* OpenGL

* storm (stormlib by Ladislav Zezula)

* Boost

* Qt 5

Further following libraries are required for MySQL GUID Storage builts:

* LibMySQL

* MySQLCPPConn

## Windows ##

* install msvc++

* install cmake

* install boost via https://sourceforge.net/projects/boost/files/boost-binaries/ (be sure to use the right version and compiler version. cmake may not support the latest version) to 

* install Qt via https://www.qt.io/download-open-source/#section-2 to 

* download stormlib from https://github.com/ladislav-zezula/StormLib

 * open CMake GUI

 * configure, generate (save the cache entry CMAKE_INSTALL_PREFIX path somewhere, set it to a empty folder if not present)

 * open solution with visual studio

 * build ALL_BUILD, then INSTALL

* open CMake GUI

 * set cache entry CMAKE_PREFIX_PATH (path) to ;, e.g. C:/Qt/5.6/msvc2015;

 * set cache entry BOOST_ROOT (path) to , e.g. C:/local/boost_1_60_0

 * set cache entry CMAKE_INSTALL_PREFIX (path) to a empty destination, e.g. C:/Users/loerwald/Documents/noggitinstall

 * configure, generate

 * open solution with visual studio

 * build ALL_BUILD

# DEVELOPMENT #

Feel   free   to   ask   the   owner  of   the   official   repository

(https://bitbucket.org/berndloerwald/noggit3/)  for  write  access  or

fork and post a pull request.

There is a bug tracker at https://bitbucket.org/berndloerwald/noggit3/issues which should be used.

# CODING GUIDELINES #

Following is  an example for file  src/noggit/ui/foo_ban.h. .cpp files

are similar.

    // This file is part of Noggit3, licensed under GNU General Public License (version 3).

    // First Lastname 

 

    //! \note Include guard shall be the full path except for src/.

    #ifndef NOGGIT_UI_FOO_H

    #define NOGGIT_UI_FOO_H

 

    //! \note   Use  fully   qualified  paths.   Standard   >  external

    //! dependencies > own.

    #include 

 

    //! \note Namespaces equal directories. (java style packages.)

    namespace noggit

    {

      namespace ui

      {

        //! \note Lower case,  underscore separated. Classes might have

        //! a _type suffix (even though being against the standard)

        class foo_ban : public QWidget

        {

        Q_OBJECT

 

        public:

          //! \note  Long  parameter  list.   Would  be  more  than  80

          //! chars.  Break  with comma  in  front.  Use  spaces to  be

          //! aligned below the braces.

          foo_ban ( type const& name

                  , type_2 const& name_2

                  , type const& name3

                  )

            : QWidget (nullptr)

          //! \note Prefer initialization lists over assignment.

            , _var (name)

          {}

 

          //! \note Use const where possible. No space between name and

          //! braces when no arguments are given.

          void render() const;

 

          //! \note If you really need getters and setters, your design

          //! might be broken.

          type const& var() const

          {

            return _var;

          }

          //! \note One  might use setter chaining.  (just as operator=

          //! returns the assigned value)

          type const& var (type const& var_)

          {

            return _var = var_;

          }

 

          //! \note Prefer const (references) where possible.

          bazs_type count_some_numbers ( const size_t& begin

                                       , const size_t& end

                                       ) const

          {

            bazs_type bazs;

 

            //! \note  Prefer   construction  over  assignment.  Prefer

            //! preincrement.

            for (size_t it (begin); it < end; ++it)

            {

              bazs.push_back (it);

            }

 

            //! \note Prefer stl algorithms over hand written code.

            const bazs_type::const_iterator smallest

              (std::min_element (bazs.begin(), bazs.end()));

 

            return *smallest;

          }

 

        private:

          //! \note Member variables are prefixed with an underscore.

          type _var;

          //! \note  Typedef when  using complex  types.  Fully qualify

          //! types.

          using baz_type = type_2;

          using bazs_type = std::vector;

          bazs_type _bazs;

        }

      }

    }