Code Monkey home page Code Monkey logo

vixen's Introduction

This contains all the publicly available content for the Vixen 3 system. At present,
this includes:

- common components used by the application and modules, in /Common
- modules developed and maintained by the core team, and other contributors, in /Modules
- the main Vixen application, in /Application
- the vixen framework, in /Vixen.System
- files to build the installer, in /Installer

You should be able to open the Vixen.sln solution and have it 'magically work'.
If you have any problems, please let us know; there's quite a few small workarounds
and gotchas used to get the modules building in two different solutions.

Conventions for module development:

- The assembly name should be the name of the module (eg. TimedSequenceEditor), and
  the default namespace should be "VixenModules.<ModuleType>.<ModuleName>". For
  example, VixenModules.Editor.TimedSequenceEditor.
 
  
- The build output directory should be relative to the solution directory, in an
  'Output' directory for debug builds, and a 'Release' directory for release builds.
  It will also depend on the type of module. For example:
  
  Vixen Modules (Debug):              $(SolutionDir)\Output\Modules\<ModuleType>\
  Vixen Modules (Release):            $(SolutionDir)\Release\Modules\<ModuleType>\
  Vixen Common assemblies (Debug):    $(SolutionDir)\Output\Common\
  Vixen Common assemblies (Release):  $(SolutionDir)\Release\Common\
  Vixen Applications (Debug):         $(SolutionDir)\Output\
  Vixen Applications (Release):       $(SolutionDir)\Release\

  Note: the $(SolutionDir) text will need to be edited in the .csproj file directly
        (ie. outside of Visual Studio), as VS escapes the '$()' macros.

  If you're unsure, look at another existing project, and copy the OutputPath for both
  Debug and Release, eg.:
  <OutputPath>$(SolutionDir)\Output\Modules\Controller\</OutputPath>
  <OutputPath>$(SolutionDir)\Release\Modules\Controller\</OutputPath>
  
 
- To reference the vixen project (or any other projects that are needed), make sure you
  add a 'project reference', and not a "normal" reference (to the binary DLL). This will
  help compatibility for other developers when used in different locations.
  

- When adding any other references, make sure you turn off the "Copy Local" option;
  with it on, we end up with copies of DLLs all over the place on output. :-)  If you're
  unsure, after building the solution, do a 'clean solution', and everything should be
  removed from the build output directory.


- Tabs vs. Spaces, and other formatting: Tabs are preferred, any other preferred formatting
  can be added here. However, please try to review all your own changes before committing,
  to ensure you are not making large changes to unrelated sections of code (eg. changing
  formatting in a file, or whitespace, etc.). Commits like this may be rejected.

vixen's People

Contributors

akonkman avatar alphageek-gb avatar aurbo99 avatar billlutton avatar ctmal avatar datdamnzotz avatar derekbackus avatar eberletj avatar ebrady1 avatar erm213 avatar gizmohd avatar gnarmstr avatar jeffu231 avatar jonathonreinhart avatar komby avatar macebobo avatar martinmueller2003 avatar oakskc avatar piense avatar sall avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.