Difference between revisions of "Main Page"

From Ciliz|W4
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
Временная страница для тестов -- [[SettingsStuffPage]] | Залогиниться -- [[Special:UserLogin]]
+
Welcome to the W4 Engine wiki!
  
''Обсуждаемо! :) Названия и описания разделов рабочие, будут корректироваться по мере наполнения.''
+
We are working on filling the wiki with documentation. The following articles are available for the time being:
  
 
{{ContentGrid
 
{{ContentGrid
Line 7: Line 7:
  
 
{{InfoCard
 
{{InfoCard
|heading = [[File:G.png|40px|link=]] <!--T:1--> Getting Started
+
|heading = General Concepts
 
|content =
 
|content =
'''Свободный стиль. Схемы.''' Общая идея. Возможности. Системные требования и требования к пользователю (программисту). Совсем поверхностная структура.
+
System architecture and main solutions:
* [[What kind of Engine is this?]]
+
* [[W4 Engine architecture]]
* [[Requirements]]
+
* [[W4 Coordinate system and Node structure]]
* [[Quick Start]]
+
* [[W4 Main Game Loop]] Needs a description
* [[Interface Description]]
+
}}
* [[Setup]]
 
}}
 
  
 
{{InfoCard
 
{{InfoCard
|heading = How does it work?
+
|heading = Parts
 
|content =
 
|content =
'''Свободный стиль. Схемы.''' Общее описание структуры (иерархия подсистем, их назначение, как они работают для программиста).
+
Complex subsystems:
* [[Main Scheme]]
+
* [[W4 Material System]]
* [[Parameters]]
+
** [[W4 Material File Format]]
* [[Basic principles]]
+
** [[W4 Default Materials]]
* [[Render Subsystem]]
+
* [[W4 Collision System]]
* [[GUI Framework]]
+
* [[W4 Component System]]
* [[FxSystem]]
+
* [[W4 Hardware Abstraction Layer]]
* [[Build System]]
+
* [[W4 Physics System]]
}} 
+
* [[W4 Graphical User Interface]]
 
+
}}
{{InfoCard
 
|heading = Let's use it!
 
|content =
 
'''Смешанный стиль (свободная вводная часть, инструкции, код и т.п., как пойдет).''' Подробное описание для разработчика приложений. В отличие от How does it work? делается упор на практическую полезность для программиста и четкие инструкции.
 
* [[Input]]
 
* [[GUI]]
 
* [[Scene]]
 
* [[Build]]
 
* [[Camera]]
 
* [[Environment]]
 
* [[Platforms]]
 
* [[W4 Nano SDK]]
 
* [[FSM]]
 
* [[Serialisation]]
 
* [[Shaders]]
 
}} 
 
 
 
{{InfoCard
 
|heading = List of Objects
 
|content =
 
'''Справочник.''' Структурированный перечень элементов, которые можно использовать. Возможно вольное описание нестандартных объектов или нестандартного использования.
 
* [[Node]]
 
* [[Mesh]]
 
* [[Participle]]
 
* [[Light]]
 
* [[Texture]]
 
}} 
 
 
 
{{InfoCard
 
|heading = Just a few modules
 
|content =
 
'''Справочник.''' Структурированное описание всех программных модулей движка (в каждом ссылка на API и пример использования). В отличие от List of Objects здесь описываются программные модули, а не механики и объекты игрового мира (но если описания совпадают, будет редирект).
 
* [[Application]]
 
* [[Audio]]
 
* [[Participle]]
 
* [[File System]]
 
* [[GUI]]
 
* [[Render]]
 
* [[Timer]]
 
* [[Transport]]
 
}}
 
  
 
{{InfoCard
 
{{InfoCard
|heading = Need some API?
+
|heading = Elements
|content =
+
|content = Special modules:
'''Только таблицы (сигнатура->описание).''' Помодульное описание API (ссылки на эти статьи должны быть доступны из архитектурного описания модулей).
+
* [[W4 Math]] Needs a description
* [[API: Application]]
+
* [[W4 Logger]] Needs a description
* [[API: Math]]
+
* [[W4 Resources]] Needs a description
* [[API: Participle]]
+
* [[W4 Event System]] Needs a description
* [[API: File System]]
+
* [[W4 Filesystem]] Needs a description
* [[API: GUI]]
 
* [[API: Render]]
 
}} 
 
 
 
{{InfoCard
 
|heading = Content Creation
 
|content =
 
'''Инструкции и/или требования.''' Описание процесса разработки ассетов (если это нам надо, или просто требования к создаваемым ассетам).
 
* [[Content Creation]]
 
}} 
 
 
 
{{InfoCard
 
|heading = We have tools!
 
|content =
 
'''Технические описания.''' Инструменты (внешние относительно движка, но разработанные нами) доступные разработчику. Здесь же подразделом могут быть сторонние инструменты, которые удобно использовать с нашим движком. Но, возможно, крупные инструменты, такие как редакторы чего-то, придется вынести совсем наверх.
 
* [[Editor]]
 
* [[Mesh Converter]]
 
* [[W4 Nano SDK]]
 
}} 
 
 
 
{{InfoCard
 
|heading = Sets of examples
 
|content =
 
'''Код и ссылки/примеры.''' Примеры сгруппированные по кейсам (и для каждого описанного модуля должна быть ссылка на такой пример).
 
}} 
 
 
 
{{InfoCard
 
|heading = Best practices
 
|content =
 
'''Свободный стиль.''' Гайды для продвинутых. В зависимости от содержания, можно объединить с Let's use it!
 
* [[File structure]]
 
}} 
 
 
 
{{InfoCard
 
|heading = Videoguides
 
|content =
 
Если будут)
 
 
}}
 
}}
  
 
{{InfoCard
 
{{InfoCard
|heading = Games and Ads
+
|heading = Tools
 
|content =
 
|content =
Портфолио работ на движке.
+
Tools for working with the W4 Engine:
 +
* [[W4 Mesh Converter]]
 
}}
 
}}
  
 
{{InfoCard
 
{{InfoCard
|heading = In development
+
|heading = How-tos
 
|content =
 
|content =
'''Свободный стиль.''' Новые фичи в разработке (в отличие от новостей, здесь дается подробное описание того, что пока не доступно).
+
How to work with the W4 Engine in simple words:
 +
* [[W4 Physics for Dummies]]
 +
* [[W4 Material Creation]]
 +
* [[W4 GUI Creation]]
 +
* [[W4 FSM]] Needs a description
 
}}
 
}}
 
}}
 
}}
  
 
__NOTOC__
 
__NOTOC__

Revision as of 13:13, 19 August 2020

Welcome to the W4 Engine wiki!

We are working on filling the wiki with documentation. The following articles are available for the time being:



General Concepts

System architecture and main solutions:

Elements

Special modules:

Tools

Tools for working with the W4 Engine:

How-tos

How to work with the W4 Engine in simple words: