|
|
(29 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 |
| |content = | | |content = |
− |
| |
| {{InfoCard | | {{InfoCard |
− | |heading = [[File:G.png|40px|link=]] <!--T:1--> Getting Started | + | |heading = General Concepts |
| |content = | | |content = |
− | '''Свободный стиль. Схемы.''' О чем мы тут. Общая идея движка. Возможности. Системные требования и требования к пользователю (программисту). Совсем поверхностная структура. Установка и настройка. Описание интерфейса (GUI, CLI).
| + | System architecture and main solutions: |
− | * [[What kind of Engine is this?]] | + | * [[W4 Engine architecture]] |
− | * [[Requirements]] | + | * [[W4 Coordinate system and Node structure]] |
− | * [[Quick Start]]
| + | }} |
− | * [[Interface Description]]
| |
− | * [[Setup]]
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = How does it work?
| |
− | |content =
| |
− | '''Свободный стиль. Схемы.''' Основные настраиваемые параметры. Общие принципы работы. Общее описание структуры (иерархия подсистем, их назначение, как они работают для программиста). Здесь же чуть глубже описание сложных подсистем - рендера, физики, UI, файловой системы и т.п. с разбором их структуры и возможностей управления.
| |
− | * [[Main Scheme]]
| |
− | * [[Parameters]]
| |
− | * [[Basic principles]]
| |
− | * [[Render Subsystem]]
| |
− | * [[GUI Subsystem]]
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Let's use it!
| |
− | |content =
| |
− | '''Смешанный стиль (свободная вводная часть, инструкции, код и т.п., как пойдет).''' Основной раздел (в этой части можно взять за основу структуру доки UNITY). Подробное описание для разработчика приложений. В отличие от How does it work? делается упор на практическую полезность для программиста и четкие инструкции, а не общую информацию об устройстве движка. Сгруппировано по общим направлениям работы (программирование UI, AI, анимация, аудио и т.п., отдельно можно рассказать про специфику (различия для платформ и назначения приложения в целом (игра, реклама и т.п.))).
| |
− | * [[Input]]
| |
− | * [[3D]]
| |
− | * [[GUI]]
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = List of Objects
| |
− | |content =
| |
− | '''Справочник.''' Структурированный перечень элементов, которые можно использовать (ноды, свет и т.п.). Возможно вольное описание нестандартных объектов или нестандартного использования.
| |
− | * [[Nodes]]
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Just a few modules
| |
− | |content =
| |
− | '''Справочник.''' Структурированное описание всех программных модулей движка (в каждом ссылка на API и пример использования). В отличие от List of Objects здесь описываются программные модули, а не механики и объекты игрового мира (но если описания совпадают, будет редирект).
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Need some API?
| |
− | |content =
| |
− | '''Только таблицы.''' Помодульное описание API (ссылки на эти статьи должны быть доступны из архитектурного описания модулей).
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Content Creation
| |
− | |content =
| |
− | '''Инструкции и/или требования.''' Описание процесса разработки ассетов (если это нам надо, или просто требования к создаваемым ассетам).
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = We have tools!
| |
− | |content =
| |
− | '''Технические описания.''' Инструменты (внешние относительно движка, но разработанные нами) доступные разработчику. Здесь же подразделом могут быть сторонние инструменты, которые удобно использовать с нашим движком. Но, возможно, крупные инструменты, такие как редакторы чего-то, придется вынести совсем наверх.
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Sets of examples
| |
− | |content =
| |
− | '''Код и ссылки.''' Примеры сгруппированные по кейсам (и для каждого описанного модуля должна быть ссылка на такой пример).
| |
− | }}
| |
− | | |
− | {{InfoCard
| |
− | |heading = Best practices
| |
− | |content =
| |
− | '''Свободный стиль.''' Гайды для продвинутых. В зависимости от содержания, можно объединить с Let's use it!
| |
− | }} | |
| | | |
| {{InfoCard | | {{InfoCard |
− | |heading = Videoguides | + | |heading = Parts |
| |content = | | |content = |
− | Если будут)
| + | Complex subsystems: |
| + | * [[W4 Material System]] |
| + | ** [[W4 Material File Format]] |
| + | ** [[W4 Default Materials]] |
| + | * [[W4 Collision System]] |
| + | * [[W4 Component System]] |
| }} | | }} |
| | | |
| {{InfoCard | | {{InfoCard |
− | |heading = Games and Ads | + | |heading = Tools |
| |content = | | |content = |
− | Портфолио работ на движке.
| + | Tools for working with the W4 Engine: |
| + | * [[W4 AssetCreator]] |
| }} | | }} |
| | | |
| {{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]] |
| }} | | }} |
| }} | | }} |
| | | |
| __NOTOC__ | | __NOTOC__ |